软件文档的定义
软件文档的写作是为了记录目标系统的定义、规划、分析、研究、设计、开发、应用等各个阶段的设计思想和研究成果。
为什么需要软件文档
文档是计算机软件产品的重要组成部分,没有文档就不称其为软件,也更不能成为软件产品。
软件文档是一种重要的软件工程技术资料。可行性研究报告文档、项目开发计划文档、软件需求说明文档……
软件文档的规范编制,在软件开发工作中占有突出的地位和相当大的工作量。高质量、高效率的编制、分发、管理、 维护文档,及时的变更、修正扩充和使用文档,对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开 发等,对于充分发挥软件产品的效益有着重要的意义。
文档的分类
软件生存期
基于软件生存期方法,可以从形式上将软件文档大致分成两类:软件开发过程中需要填写的各种图表,及应编制的各种技术文件或管理资料。
产生和使用范围
根据其产生和使用的范围,划分为三大类:开发文档、用户文档和管理文档。
文档与使用者的关系
软件开发中产生的各类文档面向不同的用户,而软件用户应该得到的文档也在商业合同中有规定。