荔园在线

荔园之美,在春之萌芽,在夏之绽放,在秋之收获,在冬之沉淀

[回到开始] [上一篇][下一篇]


发信人: Dreamer (我与萤火虫), 信区: SoftDev
标  题: 【SE】文档的作用和分类
发信站: 荔园晨风BBS站 (Sun Jun 13 12:37:10 2004), 站内信件

原文上有很多很有价值的图示,最好直接上下面的网址看。
http://www.51cmm.com/SoftDocuments/No021.htm


                            文档的作用和分类
------------------------------------------------------------------------
                黎宇 (转载自国家计算机标准和文件模板)

  软件文档(document)也称文件,通常指的是一些记录的数据 和数据媒体,它
具有固定不变的形式,可被人和计算机阅读。它和 计算机程序共同构成了能完成
特定功能的计算机软件(有人把源 程序也当作文档的一部分)。我们知道,硬件产
品和产品资料在整 个生产过程中都是有形可见的,软件生产则有很大不同,文档
本 身就是软件产品。没有文档的软件,不成其为软件,更谈不到软件 产品。软件
文档的编制(documentation)在软件开发工作中占有突 出的地位和相当的工作量。
高效率、高质量地开发、分发、管理和维 护文档对于转让、变更、修正、扩充和
使用文档,对于充分发挥软 件产品的效益有着重要意义。 然而,在实际工作中,
文档在编制和使用中存在着许多问 题,有待于解决。软件开发人员中较普遍地存
在着对编制文档不感 兴趣的现象。从用户方面看,他们又常常抱怨:文档售价太
高、文 档不够完整、文档编写得不好、文档已经陈旧或是文档太多,难于 使用等
等。究竟应该怎样要求它,文档应该写哪些,说明什么问 题,起什么作用?这里将
给出简要的介绍。

图 文档桥梁作用
  文档在软件开发人员、软件管理人员、维护人员、用户以及计 算机之间的多
种桥梁作用可从图中看出。软件开发人员在各个阶段中以文档作为前阶段工作成果
的体现和后阶段工作的依据,这个作用是显而易见的。软件开发过程中软件开发人
员需制定一些工作计划或工作报告,这些计划和报告都要提供给管理人员, 并得
到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使
用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料
,我们称此为用户文档。
  以上三种文档构成了软件文档的主要部分。我们把这三种文档所包括的内容列
在图6中。其中列举了十三个文档,这里对它们作一些简要说明:
  · 可行性研究报告:说明该软件开发项目的实现在技术上、经济上和社会因
素上的可行性,评述为了合理地达到开发目标可供 选择的各种可能实施的方案,
说明并论证所选定实施方案的理由。
  · 项目开发计划:为软件项目实施方案制定出具体计划,应该包括各部分工
作的负责人员、开发的进度、开发经费的预算、所 需的硬件及软件资源等。项目
开发计划应提供给管理部门,并作 为开发阶段评审的参考。
  · 软件需求说明书:也称软件规格说明书,其中对所开发软件的功能、性能
、用户界面及运行环境等作出详细的说明。它是用 户与开发人员双方对软件需求
取得共同理解基础上达成的协议, 也是实施开发工作的基础。
  · 数据要求说明书:该说明书应给出数据逻辑描述和数据采 集的各项要求,
为生成和维护 系统数据文卷作好准备。
  · 概要设计说明书:该说 明书是概要设计阶段的工作 成果,它应说明功能
分配、模 块划分、程序的总体结构、输 入输出以及接口设计、运行设 计、数据
结构设计和出错处理 设计等,为详细设计奠定基 础。
  · 详细设计说明书:着重 描述每一模块是怎样实现的, 包括实现算法、逻
辑流程等。
  ·用户手册:本手册详细 描述软件的功能、性能和用户 界面,使用户了解如
何使用该软件。


图 三种文档
  · 操作手册:本手册为操作人员提供该软件各种运行情况的有关知识,特别
是操作方法的具体细节。
  · 测试计划:为做好组装测试和确认测试,需为如何组织测试制定实施计划
。计划应包括测试的内容、进度、条件、人员、测试用 例的选取原则、测试结果
允许的偏差范围等。
  · 测试分析报告:测试工作完成以后,应提交测试计划执行 情况的说明。对
测试结果加以分析,并提出测试的结论意见。
  · 开发进度月报:该月报系软件人员按月向管理部门提交的 项目进展情况报
告。报告应包括进度计划与实际执行情况的比较、 阶段成果、遇到的问题和解决
的办法以及下个月的打算等。
  · 项目开发总结报告:软件项目开发完成以后,应与项目实 施计划对照,总
结实际执行的情况,如进度、成果、资源利用、成本 和投入的人力。此外还需对
开发工作作出评价,总结出经验和教训。


  · 哪些需求要被满足,即回答"做什么?"
  · 所开发的软件在什么环境中实现以及所需信息从哪里来, 即回答"从何处
?"
  · 某些开发工作的时间如何安排,即回答"何时干?"
  · 某些开发(或维护)工作打算由"谁来干?" · 某些需求是怎么实现的?
  · 为什么要进行那些软件开发或维护修改工作? 上述十三个文档都在一定程
度上回答了这六个方面的问题。这可从表中看到。
表 文档所回答的问题

  至此,我们对文档的作用有了进一步的理解。每一个文档的任 务也是明确的
,任何一个文档都此是多余的。




--
如果你真的爱萤火虫,你就不应该将她困在瓶子里;
如果你真的爱萤火虫,你应该放开她,让她在天空中自由自在地飞!
虽然你会不舍得她,但是最终你就会明白这样你才真正拥有了她!

※ 来源:·荔园晨风BBS站 bbs.szu.edu.cn·[FROM: 192.168.0.223]


[回到开始] [上一篇][下一篇]

荔园在线首页 友情链接:深圳大学 深大招生 荔园晨风BBS S-Term软件 网络书店