技术文档编写经验总结

又一个项目即将结束，从编写技术文档、代码开发到联调，8个人还不到两周的时间，居然完成了，想想自己都很吃惊。

虽然是个小项目，但还是有很多东西需要沉淀下来。

正好晚上吃饱了没事干，写个博客记录一下技术文档编写经验^_^

 

1、对于一个快速迭代的项目，存粹、简单的数据模型+接口描述式的技术文档对整个项目还是有指导、推进性作用的。

2、技术文档可以多个人合作搞定，但是需要默契的配合，比如接口先写完，数据模型中的定义字段就需要和接口相匹配；接口参数命名遵循一定模式，可以是驼峰式的。

3、一般来说，开发需要严格遵循技术文档去编写，如果有不同意见，就需要开发人员及时向技术文档编写者提出，存在一个求同存异、逐步优化的过程。

4、开发完成之后需要压测、全路径覆盖集成测试、代码审计及修正才能具备上线条件，后续还需要考虑代码优化问题。

5、当然项目成功与否的关键是离不开大家的共同努力的，合作氛围很重要；另外，技术开发与业务场景相结合也是非常重要的一环。