在 DeepSeek Harness(DSH)的工作流中,文档编写、变更日志整理以及代码审查往往是重复且耗时的环节。docgen 插件为 DSH 提供了一套文档工坊技能包,包含 README 生成、PR 描述生成、变更日志生成和代码审查等纯提示词 Agent Skills。
该插件由 JohnXu22786 维护,采用 MIT 许可证。它解决了开发者需要频繁编写或更新项目文档、描述代码变更以及进行代码审查的需求,通过标准化的 Skill 接口提供自动化支持。
核心能力¶
docgen 提供四个自包含的技能,均基于 SKILL.md 规范:
- README 生成:从代码库生成或重写 README.md,仅输出基于证据的内容。
- PR 描述生成:基于代码差异和提交历史生成完整的 PR 描述。
- 变更日志生成:对 Git 历史进行分类、合并和重写,生成 CHANGELOG。
- 代码审查:输出结构化的审查意见,包含判定结果、分级问题列表和亮点。
安装与启用¶
通过 DSH 的插件加载器安装:
dsh plugin --profile demo add github:JohnXu22786/docgen
使用方法¶
在会话中自然语言触发技能,系统会根据 description 或 whenToUse 字段自动路由。典型示例包括:
- “Write a README for this project”
- “Generate a PR description for the change I just made”
- “Update the changelog from git history and prepare 1.2.0”
- “Help me review this PR”
技能输出为 Markdown 文本,可直接保存。调用时可附加风格参数,如 length=concise 或 language=en。
注意事项¶
- 零依赖:插件无第三方依赖,支持离线运行。
- 自包含:每个技能均为自包含的
SKILL.md文件。 - 源码安全:插件为开源代码,安装前请检查源码。
- 许可证:使用需遵守 MIT 许可证。