简介

你是否还记得上次加入一个新项目时，花了好几个小时在层层叠叠的目录和文件中迷失方向？这种情况完全可以避免。真正优秀的文档能够帮助一个完全的新手在几秒钟内找到他们需要的代码行。可惜的是，文档缺失的问题常常被人们忽视。这也不奇怪——编写高质量文档需要很高的技巧，而我们中的许多人并不擅长这一点。此外，文档与代码很容易脱节。除非建立严格的更新和审查流程，否则很容易忘记文档本身也需要持续维护。