软件文档编写参考指南.docx

软件文档编写参考指南.docx软件文档编写参考指南
《立项建议书》编写参考指南 2
《软件项目投标书》编写参考指南 7
《软件产品开发任务书》正文样木 8
《软件开发计划书》编写参考指南 12
《用户需求报告》编写参考指南 16
《需求规格书》编写参考指南 21
《用户需求扌艮告》评审记录表 26
&《需求变更管理表》编写参考指南 27
《架构设计说明书》编写参考指南 28
《详细设计说明书》编写参考指南 33
《设计说明书评审记录表》 38
《使用手册》编写参考指南 39
《安装手册》编写参考指南 40
《测试报告》编写参考指南 41
《质量保证计划》编写参考指南 43
《内部员工培训登记表》 47
《用户培训登记表》 48
《立项建议书》编写参考指南
《立项建议书》
引言 (Introduction)
目的(Purpose)
本文档是软件立项书，目的是代替可行性分析。
范围(Scope)
本文档只适应于软件立项。
术语定义(Terms Glossary)
对软件组织内部和外部有关的行业术语、专用名词进行定义。
[1]……
⑵……
参考资料(References)
对书写该立项书所用到的有关资料进行说明。
[1]……
⑵……
相关文档(Related Documents)
当该文档变更时，可能对其他文档产生影响，受影响的文档叫做相关文档，需将它们一一列出。
[1]……
⑵……
版本更新记录(Version Updated Record)
任何一次版本创建或维护更新，都要追加一条记录。一个版本创建只有一次，但对它的维护更新可能 有多次。大版本升级一次，定义为创建一次，女口 」，只是维护更新一次。版本 更新记录格式，如表1-1所示。
表1-1版本更新记录
版本号
创建者
创建日期
维护者
维护日期
维护纪要

王大林
2001/01/03
—
—
—

—
—
王小林
2001/02/10
网络版功能维护
项目概述及架构(Project Summary and Framework)
项目概述(Project Summary)
宏观上说明该项目是什么、能干什么、要求干得怎么样。
项目架构(Project Framework)
宏观上描述该项目的架构：单机结构、C/S结构、B/S结构。并说明结构具体详细的运行平台：硬件 的要求、操作系统的要求、数据库管理系统的要求、对外接口的要求。
3・客户群分析(Client Analysis)
客户群定位(Client Orientation)
单机结构、C/S结构、B/S结构对应哪三种客户群，每种客户群的数量、素质、市场前景等。
当前客户群分析(Current Client Analysis)
当前客户群是指已签订合作协议或将要签订合作协议的客户群，分析他们的数量、素质、市场前景等。
潜在客户群分析(Latency Client Analysis)
潜在客户群是指将来可能发展的客户群，分析他们的数量、素质、市场询景等。
项目功能(Project Function)
项目的功能既可用Use Case图描述，又可用功能点列表描述。
单机版功能(Stand-alone Function)
单机版功能，如表1-2所示。
表1-2单机版功能
编号
功能名称
功能描述
输入内容
输出内容
1
2
网络版功能(Network Function)
网络版功能，如表1-3所示。
表1-3网络版功能
编号
功能名称
功能描述
输入内容
输出内容
1
2
(Internet Function) 互联网络版功能，如表1-4所示。
表1-4互联网络版功能
编号
功能名称
功能描述
输入内容
输出内容
1
2
项目性能(Project Performance)
响应时间(Response Time)
单机结构(包括主机多用户结构，即H/T结构)、C/S结构、B/S结构三种架构的终端数量，要求响 。
处理速度(Disposal Speed)
C/S结构、B/S结构两种架构的后台结算方式，结算速度分析。
最大终端负载(The Highest Terminal Load)
C/S结构、B/S结构两种架构的并发处理最大终端(用户)负载数量分析。
以上性能要求，最好也用列表的形式给出