技术团队如何维护文档

文章预览

 今天和大家说一个技术团队的老问题：一个长期持续迭代的项目，代码已经翻过很多次了，但是技术文档还是最初的样子，后来的技术人员依靠文档已经无法正确了解项目最初的样子了。或者是，技术文档写了很多，但是根本没人看，不同人写的文档不够统一和规范。          在讨论解决方案之前，我们首先将技术文档做一个分类：          1. 对外展示的技术文档，比如Tutorial、Programming Guide。 2. 从代码注释中由软件生成的，一般是API Guide文档。 3. 内部开发资料、参考资料，比如系统设计方案，技术设计方案。 由于第1类文档面对外部客户，受重视程度自然就高，所以不太存在无法同步更新的问题。 所以，我们今天的讨论，主要针对于第3类文档。 在 ………………………………