代码仓库文档编写与更新
提供文档主题和已有项目资料,核对代码、工单或讨论记录后,在仓库中新建或更新可供团队查阅的文档。
功能与用途
把团队已经弄清楚的项目知识写进代码仓库,方便新人上手、值班同事查阅,也方便后续维护者理解当时的决定。告诉它要记录什么、写给谁,并提供相关代码、配置、工单或讨论记录。它可以编写或更新上手指南、运维手册、架构决策记录、接口说明和故障复盘,把待确认的问题单独列出,并告知保存位置。使用时需要在已配置 Claude Prime 的 Claude Code 中访问相关资料,并拥有目标目录的写入权限。
适用场景
- 更新新人上手指南:根据安装脚本、配置示例和常见报错,更新现有指南,让新成员能在本地跑起项目。
- 保存架构决策:把已敲定的方案、选择理由和取舍写成架构决策记录,供后续维护者查阅。
- 归档故障复盘:把事故工单和复盘讨论整理成文件,记录影响、时间线、已确认的原因和后续行动。
- 同步接口说明:对照接口实现和测试用例,更新请求参数、响应格式和错误码。
适用人群
- 软件开发工程师
- 开源项目维护者
- 技术负责人
- 运维值班工程师
使用步骤
- 在项目仓库中运行 /create-doc 并填写主题。
- 说明文档类型和读者,指出相关代码、工单或讨论记录。
- 如有现有文档,提供路径;篇幅较大时先确认提纲。
- 打开生成或更新的文件,核对内容和待确认事项。
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
- 使用难度
- 简单
- 版本
- 80bcfa4
- 最近更新
- 2026-11-11
- 文件数
- 4
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过