(1)什么是文档
文档(document)是指某种数据媒体和其中所记录数据它具有永久性并可以由人或机器阅读通常仅用于描述人工可读东西在软件Software工程中文档常常用来表示对活动、需求、过程或结果进行描述、定义、规定、报告或认证任何书面或图示信息它们描述和规定了软
件设计和实现细节介绍说明使用软件Software操作命令文档也是软件Software产品部分没有文档软件Software就不成其为软件Software软件Software文档编制(documentation)在软件Software开发工作中占有突出地位和相当大工作量高质量、高效率地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档对于充分发挥软件Software产品效益有着重要意义
然而在实际工作中文档在编制和使用中存在着许多问题有待于解决软件Software开发人员中较普遍地存在着对编制文档不感兴趣现象从用户方面来看他们又常常抱怨:文档售价太高、文档不够完整、文档编写得不好、文档已经陈旧或是文档太多难于使用等等究竟应当怎样要求它文档应当写哪些内容介绍说明什~．INNi起什么作用?这里将给予简要介绍

(2)软件Software文档作用
在软件Software生产过程中总是伴随着大量信息要记录、要使用因此软件Software文档在产品开发生产过程中起着重要作用
1)提高软件Software开发过程能见度把开发过程中发生事件以某种可阅读形式记录在文档中管理人员可把这些记载下来材料作为检查软件Software开发进度和开发质量依据实现对软件Software开发工程管理
2)提高开发效率软件Software文档编制使得开发人员对各个阶段工作都进行周密研究、全盘权衡、从而减少返工并且可在开发早期发现和不致性便于及时加以纠正
3)作为开发人员在定阶段工作成果和结束标志
4)记录开发过程中有关信息便于协调以后软件Software、开发、使用和维护
5)提供对软件Software运行、维护和培训有关信息便于管理人员、开发人员、操作人员、用户的间协作、交流和了解使软件Software开发活动更科学、更有成效
6)便于潜在用户了解软件Software功能、性能等各项指标为他们选购符合自己需要软件Software提供依据
文档在各类人员、计算机的间多种桥梁作用中看出:
既然软件Software已经从手工艺人开发方式发展到工业化生产方式文档在开发过程中就起到关键作用从某种意义上来说文档是软件Software开发
规范标准体现和指南按规范标准要求生成整套文档过程就是按照软件Software开发规范标准完成个软件Software开发过程所以在使用工程化原理和思路方法来指导软件Software开发和维护时应当充分注意软件Software文档编制和管理

(3)文档分类
软件Software文档从形式上来看大致可分为两类:
类是开发过程中填写各种图表可称的为工作表格；另类是应编制技术资料或技术管理资料可称的为文档或文件
软件Software文档编制可以用自然语言特别设计形式语言介于两者的间半形式语言(结构化语言)各类图形表示表格来编制文档文档可以书写也可以在计算机支持系统中产生但它必须是可阅读
按照文档产生和使用范围软件Software文档大致可分为 3类:
1)开发文档:这类文档是在软件Software开发过程中作为软件Software开发人员前阶段工作成果体现和后阶段工作依据文档包括软件Software需求介绍说明书、数据要求介绍说明书、概要设计介绍说明书、详细设计介绍说明书、可行性研究报告、项目开发计划
2)管理文档:这类文档是在软件Software开发过程中由软件Software开发人员制定需提交人员砦工作计划或工作报告使管理人员能够通过这些文档了解软件Software开发项目安排、进度、资源使用和成果等包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发整理总结
3)用户文档:这类文档是软件Software开发人员为用户准备有关该软件Software使用、操作、维护资料包括用户手册、操作手册、维护修改建议、软件Software需求介绍说明书

(4)[Page]软件Software文档工作
国家标准局在1988年1月发布了计算机软件Software开发规范标准和软件Software产晶开发文件编制指南作为软件Software开发人员工作准则和规程它们基于软件Software生存期思路方法把软件Software产品从形成概念开始经过开发、使用和不断增补修订直到最后被淘汰整个过程应提交文档归于以下十 3种下面对其中每个文档做些简要介绍说明:
1)可行性研究报告:介绍说明该软件Software项目实现在技术上、经济上和社会原因上可行性评述为合理地达到开发目标可供选择各种可能实现方案介绍说明并论证所选定实施方案理由
2)项目开发计划:为软件Software项目实施方案制定出具体计划它应包括各部分工作负责人员、开发进度、开发经费概算、所需硬件和软件Software资源等项目开发计划应提供给管理部门并作为开发阶段评审基础
3)软件Software需求介绍说明书:也称软件Software规格介绍说明书其中对所开发软件Software功能、性能、用户界面机运行环境等作出详细介绍说明它是用户和开发人员双方对软件Software需求取得共同理解基础上达成协议也是实施开发工作基础
4)数据要求介绍说明书:该介绍说明书应当给出数据逻辑描述和数据采集各项要求为生成和维护系统数据文件做好准备
5)概要设计介绍说明书:该介绍说明书是概要设计工作阶段成果它应当介绍说明系统功能分配、模块划分、总体结构、输入输出及接口设计、运行设计、数据结构设计和出错处理设计等为详细设计奠定基础
6)详细设计介绍说明书:着重描述每个模块是如何实现包括实现算法、逻辑流程等
7)用户手册:详细描述软件Software功能、性能和用户界面使用户了解如何使用该软件Software