软件编写指南

2．专案背景（可包括：（1）专案的委托单位,开发单位和主管部门；（2）该软体系统与其他系统的关系。）
3．定义（列出文档中用到的专门术语定义和缩写词的原意。）
4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）专案经核准的计画任务书，合同或上机机关的批文；（2）专案开发计画；（3）需求规格说明书；（4）测试计画（初稿）；（5）用户操作手册（初稿）；（6）文档所引用的资料、采用的标准或规范。）
2．目标（可包括：（1）人力与设备费用的节省；（2）处理速度的提高；（3）控制精度和生产能力的提高；（4）管理资讯服务的改进；（5）决策系统的改进；（6）人员工作效率的提高，等等。）
3．条件、假定和限制（可包括：（1）建议开发软体运行的最短寿命；（2）进行系统方案选择比较的期限；（3）经费来源和使用限制；（4）法律和政策方面的限制；（5）硬体、软体、运行环境和开发环境的条件和限制；（6）可利用的资讯和资源；（7）建议开发软体投入使用的最迟时间。）
1．编写目的（阐明编写详细设计说明书的目的,指明读者对象。）
2．专案背景（应包括专案的来源和主管部门等。）
3．定义（列出文档中用到的专门术语定义和缩写词的原意。）
4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）专案的计画任务书,合同或批文；（2）专案开发计画；（3）需求规格说明书；（3）概要设计说明书；（4）测试计画(初稿)；（5）用户操作手册(初稿)；（5）文档所引用的其他资料、软体开发标准或规范。）
软体文档编写指南
封面格式：
文档编号
版本号
文档名称：
专案名称：
专案负责人：
编写年月日
校对年月日
审核年月日
批准年月日
开发单位
系统规约说明书（SystemSpecification）
一．引言
A.文档的范围和目的
B.概述
1．目标
2．约束
二．功能和数据描述
A.系统结构
1．结构关系图
2．结构关系图描述
三．子系统描述
3．定义（列出文档中用到的专门术语定义和缩写词的原文。）
4．参考资料（可包括：（1）专案经核准的计画任务书,合同或上机机关的批文；（2）专案开发计画；（3）文档所引用的资料，标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。）
二．任务概述
1．目标
2．运行环境
3．条件与限制
三．数据描述
1．静态数据
2．动态数据（包括输入数据和输出数据。）
3．资料库描述（给出使用资料库的名称和类型。）
4．数据词典
5．数据采集
四．功能需求
1．功能划分
2．功能描述
五．性能需求
1．数据精确度
2．时间特性（如回应时间、更新处理时间、数据转化与传输时间、运行时间等。）
3．适应性（在操作方式运行环境与其他软体的介面以及开发计画等发生变化时，应具有的适应能力。）
2．支持软体（如：（1）操作系统名称及版本号；（2）语言编译系统或汇编系统的名称及版本号；（3）资料库管理系统的名称及版本号；（4）其他必要的支持软体。）
四．使用说明
1．安装和初始化（给出程式的存储形式、操作命令、回馈资讯及其含义、表明安装完成的测试实例以及安装所需的软体工具等。）
2．输入（给出输入数据或参数的要求。）
六．社会因素可行性分析
1．法律因素（如，合同责任、侵犯专利权、侵犯版权等问题的分析。）
2．用户使用可行性（如，用户单位的行政管理、工作制度、人员素质等能否满足要求。）
七．其他可供选择的方案（逐个阐明其他可供选择的方案，并重点说明未被推荐的理由。）
八．结论意见（可能是：（1）可着手组织开发；（2）需待若干条件（如资金、人力设备等）具备後才能开发；（3）需对开发目标进行某些修改；（4）不能进行或不必进行（如技术不成熟，经济上不合算等）；（4）其他。）
二．总体设计
1．需求概述
2．软体结构（如给出软体系统的结果图。）
三．程式描述（逐个模组给出以下的说明:：）
1．功能
2．性能
3．输入专案
4．输出专案
5．演算法（模组所选用的演算法。）
6．程式逻辑（详细描述模组实现的演算法，可采用:：（1）标准流程图；（2）PDL语言；（3）N-S图；（4）PAD；（5）判定表等描述演算法的图表。）
二．任务概述
1．目标
2．运行环境
3．需求概述
4．条件与限制
三．总体设计
1．处理流程
2．总体结构和模组外部设计
3．功能分配（表明各项功能与程式结构的关系。）
四．介面设计
1．外部介面（包括用户介面软体介面与硬体介面。）
2．内部介面（模组之间的介面。）
五．数据结构设计
1．逻辑结构设计
2．物理结构设计
3．数据结构与程式的关系
7．介面
8．存储分配
9．限制条件
10．测试要点（给出测试模组的主要测试要求。）
用户操作手册（UserGuide）
一．引言
1．编写目的（阐明编写手册的目的，指明读者对象。）
2．专案背景（说明专案的来源、委托单位、开发单位及主管部门。）
3．定义（列出手册中用到的专门术语定义和缩写词的原意。）
4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）专案的计画任务书,合同或批文；（2）专案开发计画；（3）需求规格说明书；（4）概要设计说明书；（5）详细设计说明书；（6）测试计画；（7）手册中引用的其他资料、采用的软体工程标准或软体工程规范。）
六．运行需求
1．用户介面（如萤幕格式、报表格式、菜单格式、输入输出时间等。）
2．硬体介面
3．软体介面
4．故障处理
七．其他需求（如可使用性、安全保密、可维护性、可移植性等。）
概要设计说明书（ArchitecturalDesignSpecification）
一．引言
1．编写目的（阐明编写概要设计说明书的目的，指明读者对象。）
二．专案概述
1.工作内容（简要说明专案的各项主要工作,介绍所开发软体的功能性能等.若不编写可行性研究报告,则应在本节给出较详细的介绍。)
2.条件与限制（阐明为完成专案应具备的条件开发单位已具备的条件以及尚需创造的条件.必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。）
3.产品
（1）程式（列出应交付的程式名称使用的语言及存储形式。）
（2）数据格式（详细阐明每一输出数据的格式,如:首部主体和尾部的具体形式。）
（3）举例
3．出错和恢复（给出：（1）出错资讯及其含义（2）用户应采取的措施，如修改、恢复、再启动。）
4．求助查询（说明如何操作。）
五．运行说明
1．运行表[列出每种可能的运行情况,说明其运行目的.]
2．运行步骤[按顺序说明每种运行的步骤,应包括:]
软体专案计画（SoftwareProjectPlan）
一．引言
1．编写目的（阐明编写软体计画的目的，指出读者对象。）
2．专案背景（可包括：（1）专案委托单位、开发单位和主管部门；（2）该软体系统与其他系统的关系。）
3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。）
4．参考资料（可包括：（1）专案经核准的计画任务书、合同或上级机关的批文；（2）文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）
A.子系统N的结构图规约说明
B.结构字典
C.结构连接图和说明
四．系统建模和模拟结构
A.用於模拟的系统模型
B.模拟结果
C.特殊性能
五．软体专案问题
A.软体专案可行性研究报告
B.软体专案计画
六．附录
软体专案可行性研究报告（ReportforFeasibilityStudy）
一．引言
1．编写目的（阐明编写可行性研究报告的目的，指出读者对象）
（1）数据背景（说明数据来源、存储媒体、出现频度、限制和品质管理等。）
（2）数据格式（如：（1）长度（2）格式基准（3）标号（4）顺序（5）分隔符号（6）辞汇表（7）省略和重复（8）控制。）
（3）输入举例
3．输出（给出每项输出数据的说明。）
（1）数据背景（说明输出数据的去向、使用频度、存放媒体及品质管理等。）
4．可行性研究方法
5．决定可行性的主要因素
三．对现有系统的分析
1．处理流程和数据流程
2．工作负荷
3．费用支出（如人力、设备、空间、支持性服务、材料等项开支。）
4．人员（列出所需人员的专业技术类别和数量。）
5．设备
6．局限性（说明现有系统存在的问题以及为什麽需要开发新的系统。）
四．所建议技术可行性分析
1．对系统的简要描述
2．处理流程和数据流程
3．与现有系统比较的优越性
4．采用建议系统可能带来的影响
（1）对设备的影响
（2）对现有软体的影响
（3）对用户的影响
（4）对系统运行的影响
（5）对开发环境的影响
（6）对运行环境的影响
（7）对经费支出的影响
5．技术可行性评价（包括：（1）在限制条件下，功能目标是否能够达到；（2）利用现有技术，功能目标能否达到；（3）对开发人员数量和品质的要求，并说明能否满足；（4）在规定的期限内，开发能否完成。）
（1）运行控制
（2）操作资讯（（1）运行目的（2）操作要求（3）启动方法（4）预计运行时间（5）操作命令格式及说明（6）其他事项。）
（3）输入/输出档（给出建立和更新档的有关资讯，如：（1）档的名称及编号（2）记录媒体（3）存留的目录（4）档的支配[说明确定保留档或废弃档的准则，分发档的对象，占用硬体的优先顺序及保密控制等。）