文档生成器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_8ee65e73/cd-docgen。
技能介绍
问题背景
仓库能跑、能发版,但对外可读材料往往滞后:README 只写了安装命令,/api 路由没有集中说明,重大变更没写进 CHANGELOG,新同事只能靠搜代码猜行为。这类缺口在联调、开源发布或交接时会被放大。
技能如何工作
本技能面向代码库本身:根据项目结构与既有实现,生成可直接纳入仓库或交付给协作者的文档形态,典型产出包括:
- README:项目定位、使用方式与必要前置条件
- API 参考与接口清单:端点、参数、返回与调用关系
- CHANGELOG:按变更维度整理版本记录
- 注释模板:与代码风格一致的说明骨架,便于补全内联文档
当诉求是「写文档」「生成 README」「API 文档」「接口说明」「代码注释」「CHANGELOG」「文档补全」「技术文档」「使用说明」时,应对齐上述交付物,而不是泛泛的「介绍文案」。
适用边界
明确不用于市场文案、产品介绍页或营销话术。若只需要对外宣传用语而没有对应代码与接口事实,应使用其他写作流程,而非本技能。
使用场景
- 开源前要把 REST 路由与请求体整理成可提交的 API 说明文档
- 版本发版前根据近期合并记录起草 CHANGELOG 条目草案
- 新服务缺少 README,需要从仓库结构补全安装与使用说明
- 遗留模块无统一注释规范,要生成与现有风格一致的代码注释模板
适合人员
- 维护内部微服务、需在联调前给出接口清单的后端工程师
- 准备对外发布仓库、要一次性补全 README 与 API 文档的开源维护者
- 接手他人代码库、要把行为说明写成可检索技术文档的技术负责人
- 带实习生的导师,希望用统一模板补全模块级代码注释与使用说明