Crafting Effective Readmes 说明文档

# 撰写有效的 README 这是一个 Claude Code 技能，旨在帮助你根据特定的项目类型和受众编写、更新和改进 README 文件。 ## 目的 并非所有的 README 都一样。开源库需要的文档与个人项目或内部工具的文档截然不同。此技能提供： - **受众感知指导** - 不同的读者需要不同的信息 - **项目类型模板** - 适用于开源、个人、内部和配置项目的现成结构 - **任务特定工作流** - 无论是创建、更新、添加还是审查 README - **质量检查** - 风格指南和章节检查清单，以避免常见错误 ## 何时使用 当你需要执行以下操作时使用此技能： - 为新项目创建 README - 向现有 README 添加新章节 - 在变更后更新过时的文档 - 审查并刷新 README 内容 - 为你的项目类型选择合适的章节 **触发短语：** - “为这个项目写一个 README” - “帮我记录这个项目” - “为...创建文档” - “更新 README” - “审查我的 README” - “我的 README 应该包含哪些章节？” ## 工作原理 该技能遵循三步流程： ### 第 1 步：识别任务 该技能确定你正在处理哪种 README 任务： | 任务 | 何时使用 | |------|-------------| | **创建 (Creating)** | 尚无 README 的新项目 | | **添加 (Adding)** | 需要在现有 README 中记录新内容 | | **更新 (Updating)** | 功能已更改，内容过时 | | **审查 (Reviewing)** | 检查 README 是否仍然准确 | ### 第 2 步：收集上下文 根据任务，该技能会提出针对性的问题： - **创建**：项目类型是什么？解决了什么问题？实现“它能运行”的最快路径是什么？ - **添加**：需要记录什么？应该放在哪里？谁最需要这些信息？ - **更新**：发生了什么变化？哪些章节过时了？ - **审查**：将 README 与实际项目状态（package.json、主要文件等）进行对比 ### 第 3 步：生成与优化 该技能使用适当的模板，并跟进询问：“还有什么我可能遗漏的需要强调或包含的内容吗？” ## 核心功能 ### 项目类型模板 | 类型 | 受众 | 模板 | |------|----------|----------| | **开源 (OSS)** | 全球贡献者、用户 | `templates/oss.md` | | **个人 (Personal)** | 未来的自己、作品集浏览者 | `templates/personal.md` | | **内部 (Internal)** | 队友、新员工 | `templates/internal.md` | | **配置 (Config)** | 未来