documentation-quality-metrics

文档质量指标

使用此技能评估开发者文档的质量，并选择能回答实际问题的指标。它结合了编辑质量、分析数据和用户成果。

此技能源自 Docs for Developers: An Engineer's Field Guide to Technical Writing，尤其是第 9 章“衡量文档质量”。此外还融入了 Christopher Gales 和 Splunk Documentation Team 的 The Product Is Docs: Writing Technical Documentation in a Product Development Group 中的改写指导，尤其是第 11 章“衡量成功”。请勿在面向用户的输出中照搬书中的原文。来源：https://link.springer.com/book/10.1007/978-1-4842-7217-6

快速入门

1. 加载 guidelines.md，选择最精简且实用的参考资料集。
2. 明确测量要支持的决策。
3. 确定团队在采取行动前需要降低多少不确定性。
4. 先审查功能质量，再润饰结构。
5. 完整的质量或指标计划请使用 workflows/audit-doc-quality.md。
6. 优先选择包含基线和上下文的指标组合，而非孤立数字。

默认输出

审查质量或设计指标时，请返回：

1. 测量问题 - 指标或审查要支持什么决策。
2. 要降低的不确定性 - 团队目前有哪些未知之处，以及答案需要多精确。
3. 功能质量发现 - 无障碍性、目的、可查找性、准确性、完整性。
4. 结构质量发现 - 清晰度、简洁性、一致性。
5. 指标计划 - 定性和定量信号、基线、负责人和局限。
6. 建议采取的行动 - 修复、实验或数据收集。
7. 注意事项 - 现有指标无法证明什么。

目录

需求	从这里开始
了解质量维度	references/core/knowledge.md
应用审查和指标规则	references/core/knowledge.md
查看指标示例	references/core/knowledge.md
执行质量审查	workflows/audit-doc-quality.md
按任务选择路径	guidelines.md

核心原则

• 优秀的文档能够满足用户的需求。
• 功能质量比风格润饰更重要。
• 指标用于降低决策的不确定性；计数本身并不等于测量。
• 将分析数据与定性证据结合起来；单独来看，两者都无法呈现全貌。