文档衡量新来者能否了解一个项目是什么以及如何使用。没有文档的软件把成本外化给每一位用户；有文档的软件则让维护者的知识得以规模化。对于依赖决策而言，文档也是尽责程度的证据——会解释自己的项目往往也是会维护自己的项目。
- 类别：工程质量（类别内占 40%）
- 在总指数中的权重：8%
- 指标键名：
documentation
数值如何计算
一份加权清单：
| 组成部分 | 权重 | 证据 |
|---|---|---|
| README | 30 | 仓库根目录存在 README 文件 |
| 文档目录 | 25 | 存在 docs/（或等效）目录 |
| 文档/主页站点 | 15 | 仓库链接了文档或项目网站 |
| 仓库描述 | 10 | 在 GitHub 上设置了单行描述 |
| 主题标签 | 10 | 已分配 GitHub 主题标签 |
| Wiki | 10 | 已启用仓库 wiki |
各层次：从必不可少到可被发现
- README（30）是正门；它若缺失，其余一切都不会被阅读。
- 文档目录（25）标志着文档已超出单个文件的规模——通常包含指南、参考资料或架构说明。
- 文档站点（15）表明持续的投入：面向用户而非仓库访客的、经过渲染、可以导航的文档。
- 描述、主题标签与 wiki（合计 30）是可发现性元数据：它们决定项目究竟能否被找到和归类——无论是被人、被软件包索引，还是日益增多地被 AI 工具。
如何解读结果
提升数值
- 维护一份有实质内容的 README：项目用途、安装方式、最小示例与后续链接。
- 将不断增长的文档移入
docs/并发布为站点（GitHub Pages 或任何生成器）——这两步合计承载 40 分。 - 设置仓库描述与主题标签；在契合项目工作流之处启用 wiki。