Claude Code documentation-templates 技能:写能跑通的项目 README
EnglishClaude Code 安装步骤
- 从固定版本 GitHub 工作副本获取完整的 `cli-tool/components/skills/document-processing/documentation-templates` 目录。
- 将目录放入目标项目的 `.claude/skills/`,确认 `.claude/skills/documentation-templates/SKILL.md` 存在,再从项目根目录启动 Claude Code 并输入 `/documentation-templates`。
中文摘要
从固定模板整理项目说明、快速开始、配置和详细文档入口。适合把现有项目的真实命令写成新成员能逐步验证的 README。
SKILL.md 中文导读
可复现示例
给虚构的 CSV 清理工具写 README。工具读取 `sample.csv`,将空白列名修复后写入 `clean.csv`。根据提供的实际运行方式写快速开始,并说明怎样核对输出。工作步骤
- 先核对真实启动步骤与运行结果,再补充最低限度的环境与配置。
- 把详细 API 和架构内容放到对应文档,从 README 保留直接入口。
验收方法
README 应先说明用途,列出示例输入、已确认的启动步骤和可观察的输出文件。详细字段规则放在已有说明中,并能通过链接打开。
GitHub 原文 · 更新日期
适用环境
需要 Claude Code 和固定版本的技能目录。准备项目实际启动说明、可公开的配置样例和文档路径。
常见问题
快速开始里需要列出所有配置吗?
先写跑通首个示例所需的配置和默认值。其他选项可以放到配置章节或详细文档,便于读者按需查阅。