如果开发者是软件行业的超级英雄，那么缺乏文档就是我们的致命弱点。
凯尔西·海塔韦尔
凌晨四点，你的警报器响了。你公司的服务崩溃了，客户陷入恐慌。你在一个半熟悉的代码库中匆忙查找根本原因。单元测试中的错误消息令人沮丧，内部的 README 只是由重复的一个字组成的标题后面跟着的：[TODO]。
或者，也可能是你的服务表现得很好，而且越来越好。随着更多的客户注册，他们有问题。太多问题。随着服务规模的扩大，电子邮件和支持工单涌入，你被迫离开开发工作，转向支持工作。
大多数人都不得不通过在最需要文档的时候发现它缺失来学习文档的重要性，这是一种艰难的方式。
良好文档化的项目为项目中的开发者和软件用户节省时间。缺乏足够文档支持的项目将遭受开发者生产率、项目可扩展性、用户采用率和可访问性的影响。简而言之：糟糕的文档会扼杀项目。
我们发现文档质量预测团队在实施技术实践方面的成功。而这些实践又预测了系统技术能力的提高，比如可观察性、持续测试和部署自动化。
Google 2021加速DevOps报告
"开发者文档"揭示了创建出色开发者文档的过程，跟随着软件开发团队在推出新产品时的工作。在每个阶段，你将通过示例、模板和原则学习如何创建、衡量和维护文档。
学习如何创建使你和用户更高效的文档。
这本书对开发文档的处理方式就像《凤凰项目》对DevOps的处理方式一样——它使你的愿望变为现实。
安妮·杰特尔，《文档如代码》作者
Comments