大话软件文档

说起软件文档，我是既爱又恨。

这几天我在写项目的文档。作为项目软件副主师，要写一些文档。其中就有我正在写的软件系统规格说明书，看名字就知道，就是需求分析。

但是像我们公司这样的项目组织架构，我认为软件需求分析就没有必要写，或者不是很有必要。项目是这样设置的，有项目经理，电讯主师，就是项目主师，有结构副主师，还有就是软件副主师。在之前，主师就已经写了一个近百页的总体技术方案，并进行了评审。方案非常详细，各个分系统的需求其实写的已经很详细了。所以我认为各分系统根据这个方案就可以进行做设计了，没有必要再写软件系统需求规格了。

但这个系统需求规格说明书我也写了将近五天。主要是将总体技术方案的有关部分摘录出来，再稍加整理，其实不难。但系统需求规格的模板中目录很让人费解，并且软件模块很多，有十几个，一个一个写起来，都是格式化的文档，很乏味。只好写几段，就休息一下，做点别的，再回来写。

开发人员一般都不喜欢写文档，但开发管理流程就是这样，不写也不行，所以什么好纠结的，写呗！

但其实在另一方面，在看别人的代码，或者维护一个时间比较久远的项目时，就特别希望能有一些文档，这样就容易知道软件的功能，当初是如何设计的。特别是接口文档，如果能及时更新，反映软件真实的接口状况，在维护软件时还是很有帮助的。

所以，文档这件事，让人既爱又恨。