Claude Code docs-writer:给开源工作流写快速开始和排障
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/docs-writer/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/docs-writer/`,把核对后的文件保存为 `.claude/skills/docs-writer/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/docs-writer`。
中文摘要
将项目的入口、配置、协作职责和已确认的排障办法整理成 README 与独立教程。
SKILL.md 中文导读
可复现示例
教程 guide-17 的样例说明明确现有命令是“tool check --sample”,成功消息为“Sample configuration is valid”。失败常见原因是样例配置未从项目根目录读取。工作步骤
- 从已确认的命令及输出提炼最短入门路径。
- 补上常见失败原因和下一步链接,把详细设计放在独立文档。
验收方法
快速开始应保留 [tool check --sample, Sample configuration is valid],并注明接下来可接入项目配置。排障说明明确先从项目根目录重试。
GitHub 原文 · 更新日期
适用环境
在 Claude Code 中打开使用 Agentic PRD Workflow 或同类结构的开源项目,准备已核实的操作命令和对应输出。
常见问题
配置原理和团队分工都需要放在 README 吗?
README 先说明项目用途和最短操作路径。详细设计和协作职责单独写,并从入口文档引用。