前言

听说要写文档,程序员的第一反应是:为什么要写文档?不写!程序员的我们善于编码、善于讨论方案、争辩技术,大多不善于交流、尤其不善于写文档。记得我们团队有的童鞋的周报就一句话:修改bug:TDXXXX,TDXXX2,TDXXX3….
那么问题就来了,程序要要不要写文档?为什么要写文档?如何写好文档。

1、文档有哪些?

沟通纪要、会议纪要、周报、工作总结、需求文档、总体设计文档、详细设计文档、单元测试文档、测试用例文档、需求变更文档、产品说明书、项目总结文档等等。

2、写文档目的是什么?

你有没有遇到过开晨会、周会的时候某个问题已经讨论的很清晰。但是几天后或者临近周末的时候再说这个问题的时候,团队中有的童鞋会说:“我不知道,没有说过这个问题或者这个方案”,因此而造成的BB事很伤神费心。
为了避免出现问题后的瞎BB,特需要形成文字记录下来。

收藏 打印