首先我们要明确项目过程中产生的文档,其作用和价值是什么。——是为了交流需要。
另外一点就是文档本身的含义了。即固化语言,产生记忆的实物载体。
无论是需求文档,详细设计文档,软件维护文档,还是其他一些文档。无非就是以下
作用:
1、是为了方便项目涉及人员间的交流。
2、也有助于我们现在及以后查阅,参考的需要。
3、便于项目人员现在及以后与计算机的交流。
总之,文档存在的价值在于交流,如果一个人软件的生命周期到了,以后谁也不在探
讨或使用这个软件了,那么这个软件的相关文档也没人看了,文档还有什么意义。
但对于项目涉及人员的不同,交流对象的不同,交流目的的不同。我们在编写文档的
过程中,对文档的组织,文档的编写内容,甚至文档中的每一个措词也是不同的。
就我们公司的的原则而言,大致分为以下几种文档:
1、如果文档是为项目组内部成员交流使用的,能够把问题描述清楚,不产生歧义即可。
对于编写方式,甚至用记事本大致写一下即可。
2、给公司领导看的就要按照公司内部的行文规范要求进行编写。
3、对于客户或外部交流用的文档,或者是参与竞标之类的文档就要。严格的按照行业
规范及通用文档规范进行组织编写。