[ PROMPT_NODE_25972 ]
using-references
[ SKILL_DOCUMENTATION ]
# 使用参考资料
模板是你编写 README 的主要工具。参考资料提供了深度——使用它们来完善你的理解或处理边缘情况。
**提示:** 不要一次性加载所有参考资料。选择最适合你当前情况的一项。
---
### art-of-readme.md
`references/art-of-readme.md`
**原因:** 优秀 README 背后的哲学——理解读者如何实际扫描和评估项目
**内容:** 认知漏斗(从广泛到具体)、简洁作为一种特性、将 README 作为让用户无需查阅源码的“一站式商店”
---
### make-a-readme.md
`references/make-a-readme.md`
**原因:** 关于包含哪些内容的实用、分章节指导
**内容:** 逐一讲解每个常见章节(名称、描述、安装、使用等)并提供具体建议。好的提醒:“太长总比太短好”
---
### standard-readme-spec.md
`references/standard-readme-spec.md`
**原因:** 当一致性或合规性很重要时的正式规范
**内容:** 必需与可选章节、确切顺序、格式规则。对于想要标准化格式的开源项目非常有用。
示例:
- `references/standard-readme-example-minimal.md` - 最低限度合规的 README
- `references/standard-readme-example-maximal.md` - 功能齐全,包含徽章、目录、所有可选章节