关于 project-docs
project-docs 是一项用于让项目文档保持准确并与代码同步的技能。它指导开发者定位规范文档、精简更新内容，并核对示例与术语。
主要功能
- 01识别面向用户的代码变更
- 02定位规范文档
- 03尽量精简地更新文档
- 04依据 CLI 和代码核对示例
- 05检查术语与配置的一致性
适用场景
- 01记录新增 CLI 参数或配置变更
- 02更新 API 或协议参考文档
- 03在行为变更后检查文档
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/project-docs确认已加载。
详细介绍
项目文档
此技能可帮助你确保文档准确、精简，并与代码库保持一致。
需要记录的内容
- 面向用户的行为变更
- 新增的 CLI 标志、环境变量和配置变更
- 协议/API 变更、请求/响应格式
- 运维指南（故障排除、限制、安全工作流）
文档更新工作流
- 确认代码变更及其对用户可见的影响。
- 找到权威文档（README、指南或参考文档）。
- 尽量减少改动，并遵循现有风格更新文档。
- 根据当前 CLI 帮助信息/代码交叉检查示例。
- 运行相关测试，并在更新说明中列出测试。
一致性检查
- 选项名称与实际 CLI 标志一致（如有
--help输出，请以其为准）。 - 默认值正确，且仅说明一次（避免在多份文档中重复）。
- 示例可运行，且不依赖项目私有路径。
- README、指南和参考文档中的术语保持一致。
调用子 Agent（docs-excellence-architect）
使用 Task 工具，将以文档为重点的审查委派给专用子 Agent：
- subagent_type：
docs-excellence-architect
请提供：
- 需要修改的文档文件
- 需要在文档中体现的代码变更
- 期望的文档结构（各部分应放在哪里）
示例提示词：
Review and update docs for the following changes:
- <change 1>
- <change 2>
Target files:
- README.md
- guides/*.md
- docs/*.md
Constraints:
- Minimal churn, match local style
- Ensure examples are accurate and consistent
Deliverables:
- Proposed edits (diff-style)
- A checklist of what was verified
维护指南
- 优先使用简短章节和具体示例。
- 避免在多个文件中重复相同的定义。
- 当文档成为参考资料时，将其移至单一权威位置并添加链接。
评论
支持 Markdown