# 文档质量检查表 在输出技术文档前，至少检查以下问题： ## 来源真实性 - 是否引用了真实文件、真实符号、真实示例？ - 是否区分了“代码事实”和“推断结论”？ - 是否标注了限制和待确认项？ ## 结构完整性 - 是否先交代目标，再给细节？ - 是否有最小可用示例？ - 是否有关键设计或注意事项？ - 是否给出了相关链接或延伸阅读？ ## 可维护性 - 标题层级是否清晰？ - 术语前后是否一致？ - 路径、类名、方法名是否使用了正确大小写？ - 是否适合后续增量维护，而不是一次性文案？ ## 读者体验 - 新人能否快速理解“这是什么、怎么用”？ - 维护者能否找到“关键边界、风险、坑点”？ - 是否避免了长篇空话和没有证据的结论？