documentation-standards
Claude Code documentation-standards 技能:制定 README 和项目文档规范
EnglishClaude Code 安装步骤
- 从下方 GitHub 原文打开固定提交,在同一提交中取得 `tech-lead/engineering-excellence/skills/documentation-standards/` 技能目录。
- 将目录复制到项目内的 `.claude/skills/documentation-standards/`,确认 `SKILL.md` 与附带文件位于该目录。
- 在项目根目录启动 Claude Code,输入 `/documentation-standards` 加上示例中的任务说明。
中文摘要
梳理 README、接口参考、操作指南和架构文档各自负责的内容,建立模板、维护负责人和复审时间。
SKILL.md 中文导读
可复现示例
准备 README.md 和 docs/setup.md,两个文件都写着项目启动命令。请 Claude 划分两个页面的用途,给出权威位置、导航改动、负责人和复审日期字段。工作步骤
- 列出已有文档及重复段落。
- 确定每类内容的主维护位置。
- 为文档设置入口、负责人和复审周期。
验收方法
整理草案指定一处维护完整安装步骤,另一处保留简明入口,并给页面补上负责人和复审记录。
GitHub 原文 · 更新日期
适用环境
Claude Code 与本地项目的 README 或文档目录。
常见问题
怎么减少同一安装命令在多份文档里过期?
选定一处维护完整命令,让其他页面指向它,并在安装方式变更时让文档负责人同步核对。