JohnXu22786/docgen

README 摘要

docgen — 文档工坊技能包 一组纯提示词（Agent Skills）形态的文档生成技能，为 dsh 等插件化 agent harness 提供四项能力： README 生成、PR 描述生成、changelog 生成、代码审查 。所有技能遵循 Agent Skills 开放标准（ SKILL.md + YAML frontmatter），自包含、无第三方依赖、离线可用。 包含的技能 技能 做什么 何时用 readme-forge 从代码库生成/重写 README.md，只写有证据的内容 「给这个项目写个 README」 pr-dossier 从 diff 与提交历史生成完整 PR 描述（变更档案） 「为这次改动写 PR 描述」 changelog-curator 从 git 历史分类、合并、改写生成 CHANGELOG 「更新 changelog，准备发版」 diff-verdict 输出结构化审查意见：结论 + 分级问题清单 + 亮点 「审查一下这个 PR」 每个技能都是 自包含的单个 SKILL.md ：正文包含输入收集指引、工作流程、输出模板与模板变量表、语言风格选项、输出质量检查清单、「不要做」清单与边界情况处理。 目录结构 安装与接入 dsh dsh 通过 skill-filesystem 提供方按 技能根目录 发现技能（一层深度：目录束 / /SKILL.md 或平铺文件 / .md ）。接入本插件任选一种方式： 方式一：项目级（推荐，零配置） 把 skills/ 下的四个技能目录（或整个 skills/ ）放进项目的技能根目录： 方式二：用户级（所有项目可用） 方式三：自定义目录（插件原地接入，不拷贝） 通过配置给 skill-filesystem 提供方登记 customSkillDirs ，例如用补丁文件（见 examples/dsh-patch-enable-skills.yml ）： 注意：dsh 的 web profile 默认关闭技能相关组件（ skill-filesystem / tool-skill ），需要补丁或 preset 启用； headless profile 默认开启。具体配置键路径以你所装版本的 dsh --dump-config 与官方文档为准。 验证安装 接入后在会话中直接以自然语言发起请求即可，模型会通过 skill 工具加载对应技能： 使用说明 - 触发 ：在提问中自然描述需求（见技能表「何时用」列），无需记住技能名；harness 依据 description / whenToUse 自动路由。 - 风格选项 ：每个技能支持三种可覆盖维度——语言（默认跟随提问语言）、篇幅（精简/标准/详尽或完整）、语气/深度。以自然语言追加即可： 篇幅=精简 、 关注=安全 、 language=en 。 - 输出形…

分类