??xml version="1.0" encoding="utf-8" standalone="yes"?> 软g文(document)也称文gQ通常指的是一些记录的数据 和数据媒体,它具有固定不变的形式Q可被h和计机阅读。它?计算机程序共同构成了(jin)能完成特定功能的计算Y?有h把源 E序也当作文的一部分)。我们知道,g产品和品资料在?个生产过E中都是有Ş可见的,软g生则有很大不同Q文本 w就是Y件品。没有文档的软gQ不成其YӞ更谈不到软g 产品。Y件文的~制(documentation)在Y件开发工作中占有H?出的C和相当的工作量。高效率、高质量地开发、分发、管理和l?护文档对于{让、变更、修正、扩充和使用文Q对于充分发挥Y 件品的效益有着重要意义?/P>
然而,在实际工作中Q文在~制和用中存在着许多?题,有待于解冟뀂Y件开发h员中较普遍地存在着对编制文不?兴趣的现象。从用户斚w看,他们又常常抱怨:(x)文售h(hun)太高、文 不够完整、文编写得不好、文已l陈旧或是文太多,难于 使用{等。究竟应该怎样要求它,文应该写哪些,说明什么问 题,起什么作?q里给出简要的介绍?/P>
?.2 文桥梁作用 文在Y件开发h员、Y件管理h员、维护h员、用户以?qing)?机之间的多U桥梁作用可从图9Q?中看出。Y件开发h员在?个阶D中以文作为前阶段工作成果的体现和后阶D工作的?据,q个作用是显而易见的。Y件开发过E中软g开发h员需制定 一些工作计划或工作报告Q这些计划和报告都要提供l管理h员, q得到必要的支持。管理h员则可通过q些文?jin)解软g开发项 目安排、进度、资源用和成果{。Y件开发h员需为用户了(jin)解Y 件的使用、操作和l护提供详细的资料,我们U此为用h。以 上三U文档构成了(jin)软g文的主要部分。我们把q三U文所?括的内容列在?中。其中列举了(jin)十三个文,q里对它们作 一些简要说明:(x) 操作手册Q本手册为操作h员提供该软g各种q行情况?有关知识Q特别是操作Ҏ(gu)的具体细节? 试计划Qؓ(f)做好l装试和确认测试,需为如何组l测?制定实施计划。计划应包括试的内宏V进度、条件、h员、测试用 例的选取原则、测试结果允许的偏差范围{? 试分析报告Q测试工作完成以后,应提交测试计划执?情况的说明。对试l果加以分析Qƈ提出试的结论意见? 开发进度月报:(x)该月报系软g人员按月向管理部门提交的 目q展情况报告。报告应包括q度计划与实际执行情늚比较?阶段成果、遇到的问题和解决的办法以及(qing)下个月的打算{? 目开发ȝ报告QY仉目开发完成以后,应与目?施计划对照,ȝ实际执行的情况,如进度、成果、资源利用、成?和投入的人力。此外还需对开发工作作Pȝ出经验和?训? l护修改QY件品投入运行以后,发现?jin)需对其q?行修正、更改等问题Q应存在的问题、修改的考虑以及(qing)修改的媄(jing) 响估计作详细的描qͼ写成l护修改Q提交审扏V?以上q些文档是在软g生存期中Q随着各阶D工作的开展?时编制。其中有的仅反映一个阶D늚工作Q有的则需跨越多个?Dc(din)表5l出?jin)各个文应在Y件生存期中哪个阶D늼写。这 些文最l要向Y件管理部门,或是向用户回{以下的问题Q?BR>?.2 软g生存期各阶段~制的文?
阶段 文档
user?
INSERT INTO `user` (`userid`, `name`, `password`, `zhiwu`, `beizhu`, `guanli`, `groupid`) VALUES ('1','admin_lq','liqing',NULL,NULL,1,NULL);
t_group?
INSERT INTO `t_group` (`groupid`, `name`, `parent_groupid`, `create_by`, `beizhu`, `userid`, `node_level`, `nodeid`) VALUES ('1','admin_test','1','1',NULL,NULL,1,10); INSERT INTO `user_group` (`userid`, `groupid`) VALUES ('1','1');
2.用户l只能设|一个维护h?t_group表中的userid字段即ؓ(f)l护人员字段,它设|ؓ(f)外键U束user表的userid;
]]>
可行性研I报?/STRONG>Q说明该软g开发项目的实现在技术上、经 上和社?x)因素上的可行性,评述Z(jin)合理地达到开发目标可?选择的各U可能实施的Ҏ(gu)Q说明ƈ所选定实施Ҏ(gu)的理 由?BR>
目开发计?/STRONG>Qؓ(f)软g目实施Ҏ(gu)制定出具体计划,?该包括各部分工作的负责h员、开发的q度、开发经费的预算、所 需的硬件及(qing)软g资源{。项目开发计划应提供l管理部门,q作 为开发阶D评审的参考?
软g需求说明书Q也UY件规D明书Q其中对所开发Y 件的功能、性能、用L(fng)面及(qing)q行环境{作l的说明。它是用 户与开发h员双方对软g需求取得共同理解基上达成的协议Q?也是实施开发工作的基础?
数据要求说明?/STRONG>Q该说明书应l出数据逻辑描述和数据采 集的各项要求Qؓ(f)生成和维?pȝ数据文卷作好准备?
概要设计说明?/STRONG>Q该?明书是概要设计阶D늚工作 成果Q它应说明功能分配、模 块划分、程序的Ml构、输 入输Z?qing)接口设计、运行设 计、数据结构设计和出错处理 设计{,l设计奠定基 ?BR>
详细设计说明?/STRONG>Q着?描述每一模块是怎样实现的, 包括实现法、逻辑程{?
用户手册Q本手册详细 描述软g的功能、性能和用?界面Q用户?jin)解如何使用该Y件?BR>
文档
用户文
用户手册
操作手册
l护修改
软g需求(规格Q说明书
开发文?/TD>
软g需求(规格Q说明书
数据要求说明?/TD>
概要设计说明?/TD>
详细设计说明?/TD>
可行性研I报?/TD>
目开发计?/TD>
理文
目开发计?/TD>
试计划
试报告
开发进度月?/TD>
开发ȝ报告
?.3 三种文档
可行性药酒与计划
需求分?/TD>
设计
代码~写
试
q行与维?/TD>
可行性研I报?/TD>
目开发计?/TD>
软g需求说?/TD>
数据要求说明
概要设计说明
星系设计说明
试计划
用户手册
操作手册
试分析报告
开发进度月?/TD>
目开发ȝ
l护修改
哪些需求要被满I卛_{“做什??
所开发的软g在什么环境中实现以及(qing)所需信息从哪里来Q?卛_{“从何处??
某些开发工作的旉如何安排Q即回答“何时干??
某些开?或维?工作打算由“谁来干??
某些需求是怎么实现?
Z么要q行那些软g开发或l护修改工作?
上述十三个文档都在一定程度上回答?jin)这六个斚w的问题。这可从表中看到?/P>
?.3 文所回答的问?/P>
所提问?/P> 文 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
xQ我们对文的作用有?jin)进一步的理解。每一个文档的?务也是明的QQ何一个文档都此是多余的?/P>