用途:在创建、补充、更新或审阅 README 时提供结构化流程和模板,帮助 README 回答目标读者真正关心的问题。核心理念是:README 的读者不同,所需信息也不同,开源贡献者、未来自己和打开配置目录的人关注点并不一样。
使用方式:先确认当前任务类型(创建、添加、更新、审阅),再按任务提出针对性问题。创建时需明确项目类型、用一句话说明解决的问题、最快跑通路径以及需要突出的内容;添加时确认要记录什么、放在现有结构何处、谁最需要;更新时先读现有 README 找出过时部分并提出具体修改;审阅时对照项目实际状态(如 package.json、主要文件)标记过时内容,若有“Last reviewed”日期则更新。起草后应追问是否还有遗漏。
项目类型:资料给出四类及对应受众和重点章节,开源项目面向贡献者和全球用户,包含安装、使用、贡献、许可证;个人项目面向未来的自己和作品集访客,包含功能、技术栈、学习心得;内部项目面向同事和新成员,包含安装配置、架构、运行手册;配置项目面向未来困惑的自己,包含有什么、为什么、如何扩展、注意事项。类型不明确时应询问,不要默认套用开源模板。
必备章节:所有 README 至少应包含名称、描述(一到两句说明是什么和为什么)、使用方式(示例有帮助)。
参考资料:资料提到 section-checklist.md(按项目类型确定应含章节)、style-guide.md(常见错误和文字指导)、using-references.md(更深入参考材料指南)。
限制:资料未提供具体命令、安装方式、价格或平台支持信息;也未给出各模板的完整内容。