Claude Code docs:选择文档类型并核对已验证内容
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/docs/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/docs/`,把核对后的文件保存为 `.claude/skills/docs/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/docs`。
中文摘要
按照读者目标创建或更新 README、操作指南、架构说明和决策记录,保留可验证的命令及相关资料。
SKILL.md 中文导读
可复现示例
文档 doc-08 要向维护者记录缓存存储方案。现有材料写明建议先用 SQLite,原因是单机运行和无需额外服务,方案当前仍待确认。工作步骤
- 判断读者要完成什么,选定文档类型和目标目录。
- 用实际资料写草稿,核对状态、链接和已有的验证结果后交付。
验收方法
草稿放进 docs/adr/,保留 {status: 'Proposed', decision: 'SQLite'},并说明背景和部署取舍,交内容负责人核对。
GitHub 原文 · 更新日期
适用环境
在 Claude Code 中准备目标读者、已有 Markdown 和来源资料。该技能按工作区规定组织文档目录。
常见问题
什么情况下适合写成 ADR?
当读者要了解采用何种方案、为什么采用以及代价时,使用包含背景、决策和后果的 ADR。