软件文档编写指南
软体文档编写指南
封面格式：
文档编号
版本号
文档名称：
专案名称：
专案负责人：
编写年月日
校对年月日
审核年月日
批准年月日
开发单位
系统规约说明书（SystemSpecification）一．引言
A.文档的范围和目的
B.概述
1．目标
2．约束
二．功能和数据描述
A.系统结构
1．结构关系图
2．结构关系图描述
三．子系统描述
A.子系统N的结构图规约说明
B.结构字典
C.结构连接图和说明
四．系统建模和模拟结构
A.用於模拟的系统模型
B.模拟结果
C.特殊性能
五．软体专案问题
A.软体专案可行性研究报告
B.软体专案计画
六．附录
软体专案可行性研究报告（ReportforFeasibilityStudy）一．引言
1．编写目的（阐明编写可行性研究报告的目的，指出读者对象）
2．专案背景（应包括：（1）所建议开发的软体名称；（2）专案的任务提出者、开发者、用户及实现单位；（3）专案与其他软体或其他系统的关系。）3．定义（列出文档中用到的专门术语的定义和缩略词的原文。）
4．参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。）
二．可行性研究的前提
1．要求（列出并说明建议开发软体的基本要求，如（1）功能；（2）性能；
（3）输出；（4）输入；（5）基本的数据流程和处理流程；（6）安全与保密要求；（7）与软体相关的其他系统；（8）完成期限。）
2．目标（可包括：（1）人力与设备费用的节省；（2）处理速度的提高；（3）控制精度和生产能力的提高；（4）管理资讯服务的改进；（5）决策系统的改进；（6）人员工作效率的提高，等等。）
3．条件、假定和限制（可包括：（1）建议开发软体运行的最短寿命；（2）进行系统方案选择比较的期限；（3）经费来源和使用限制；（4）法律和政策方面的限制；（5）硬体、软体、运行环境和开发环境的条件和限制；（6）可利用的资讯和资源；（7）建议开发软体投入使用的最迟时间。）
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．指出
（1）基建投资
（2）其他一次性支出
（3）经常性支出
2．效益
（1）一次性收益
（2）经常性收益
（3）不可定量收益
3．收益/投资比
4．投资回收周期
5．敏感性分析（指一些关键性因素，如：系统生存周期长短、系统工作负荷量、处理速度要求、设备和软体配置变化对支出和效益的影响等的分析。）六．社会因素可行性分析
1．法律因素（如，合同责任、侵犯专利权、侵犯版权等问题的分析。）2．用户使用可行性（如，用户单位的行政管理、工作制度、人员素质等能否满足要求。）
七．其他可供选择的方案（逐个阐明其他可供选择的方案，并重点说明未被推荐的理由。）
八．结论意见（可能是：（1）可着手组织开发；（2）需待若干条件（如资金、人力设备等）具备後才能开发；（3）需对开发目标进行某些修改；（4）不能进行或不必进行（如技术不成熟，经济上不合算等）；（4）其他。）
软体专案计画（SoftwareProjectPlan）
一．引言
1．编写目的（阐明编写软体计画的目的，指出读者对象。）
2．专案背景（可包括：（1）专案委托单位、开发单位和主管部门；（2）该软体系统与其他系统的关系。）
3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。）
4．参考资料（可包括：（1）专案经核准的计画任务书、合同或上级机关的批文；（2）文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）
二．专案概述
1.工作内容（简要说明专案的各项主要工作,介绍所开发软体的功能性能等.
若不编写可行性研究报告,则应在本节给出较详细的介绍。)
2.条件与限制（阐明为完成专案应具备的条件开发单位已具备的条件以及尚需
创造的条件.必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。）
3.产品
（1）程式（列出应交付的程式名称使用的语言及存储形式。）
（2）文档（列出应交付的文档。）
（3）运行环境（应包括硬体环境软体环境。）
4．服务（阐明开发单位可向用户提供的服务.如人员培训安装保修维护和其他运行支持。）
5．验收标准
三．实施计画
1．任务分解（任务的划分及各项任务的负责人。）
2．进度（按阶段完成的专案,用图表说明开始时间完成时间。）
3．预算
4．关键问题（说明可能影响专案的关键问题,如设备条件技术难点或其他风险因素,并说明对策。）
四．人员组织及分工
五．交付期限
六．专题计画要点（如测试计画品质保证计画配置管理计画人员培训计画系统安装计画等。）
需求规格说明书（RequirementsSpecification）
一．引言
1．编写目的（阐明编写需求说明书的目的,指明读者对象。）
2．专案背景（可包括：（1）专案的委托单位,开发单位和主管部门；（2）该软体系统与其他系统的关系。）
3．定义（列出文档中用到的专门术语定义和缩写词的原文。）
4．参考资料（可包括：（1）专案经核准的计画任务书,合同或上机机关的批文；（2）专案开发计画；（3）文档所引用的资料，标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。）
二．任务概述
1．目标
2．运行环境
3．条件与限制
三．数据描述
1．静态数据
2．动态数据（包括输入数据和输出数据。）
3．资料库描述（给出使用资料库的名称和类型。）
4．数据词典
5．数据采集
四．功能需求
1．功能划分
2．功能描述
五．性能需求
1．数据精确度
2．时间特性（如回应时间、更新处理时间、数据转化与传输时间、运行时间等。）
3．适应性（在操作方式运行环境与其他软体的介面以及开发计画等发生变化时，应具有的适应能力。）
六．运行需求
1．用户介面（如萤幕格式、报表格式、菜单格式、输入输出时间等。）2．硬体介面
3．软体介面
4．故障处理
七．其他需求（如可使用性、安全保密、可维护性、可移植性等。）
概要设计说明书（ArchitecturalDesignSpecification）
一．引言
1．编写目的（阐明编写概要设计说明书的目的，指明读者对象。）
2．专案背景（可包括：（1）专案的委托单位,开发单位和主管部门；（2）该软体系统与其他系统的关系。）
3．定义（列出文档中用到的专门术语定义和缩写词的原意。）
4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）专案经核准的计画任务书，合同或上机机关的批文；（2）专案开发计画；（3）需求规格说明书；（4）测试计画（初稿）；（5）用户操作手册（初稿）；（6）文档所引用的资料、采用的标准或规范。）
二．任务概述
1．目标
2．运行环境
3．需求概述
4．条件与限制
三．总体设计
1．处理流程
2．总体结构和模组外部设计
3．功能分配（表明各项功能与程式结构的关系。）四．介面设计
1．外部介面（包括用户介面软体介面与硬体介面。）2．内部介面（模组之间的介面。）
五．数据结构设计
1．逻辑结构设计
2．物理结构设计
3．数据结构与程式的关系
六．运行设计
1．运行模组的组合
2．运行控制
3．运行时间
七．出错处理设计
1．出错输出资讯
2．出错处理对策（如设置後备、性能降级、恢复及再启动等。）
八．安全保密设计
九．维护设计（说明为方便维护工作的设施,如维护模组等。）
详细设计说明书（ProceduralDesignSpecification）
一．引言
1．编写目的（阐明编写详细设计说明书的目的,指明读者对象。）
2．专案背景（应包括专案的来源和主管部门等。）
3．定义（列出文档中用到的专门术语定义和缩写词的原意。）
4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）专案的计画任务书,合同或批文；（2）专案开发计画；（3）需求规格说明书；（3）概要设计说明书；（4）测试计画(初稿)；（5）用户操作手册(初稿)；（5）文档所引用的其他资料、软体开发标准或规范。）二．总体设计
1．需求概述
2．软体结构（如给出软体系统的结果图。）
三．程式描述（逐个模组给出以下的说明:：）
1．功能
2．性能
3．输入专案
4．输出专案
5．演算法（模组所选用的演算法。）
6．程式逻辑（详细描述模组实现的演算法，可采用:：（1）标准流程图；（2）
PDL语言；（3）N-S图；（4）PAD；（5）判定表等描述演算法的图表。）7．介面
8．存储分配
9．限制条件
10．测试要点（给出测试模组的主要测试要求。）
用户操作手册（UserGuide）
一．引言
1．编写目的（阐明编写手册的目的，指明读者对象。）
2．专案背景（说明专案的来源、委托单位、开发单位及主管部门。）
3．定义（列出手册中用到的专门术语定义和缩写词的原意。）
4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）专案的计画任务书,合同或批文；（2）专案开发计画；（3）需求规格说明书；（4）概要设计说明书；（5）详细设计说明书；（6）测试计画；（7）手册中引用的其他资料、采用的软体工程标准或软体工程规范。）
二．软体概述
1．目标
2．功能
3．性能
（1）数据精确度（包括输入、输出及处理数据的精度。）
（2）时间特性（如回应时间、处理时间、数据传输时间等。）
（3）灵活性（在操作方式、运行环境需做某些变更时软体的适应能力。）
三．运行环境
1．硬体（列出软体系统运行时所需的硬体最小配置，如：（1）电脑型号、主存容量；（2）外存储器、媒体、记录格式、设备型号及数量；（3）输入、输出设备；（4）数据传输设备及数据转换设备的型号及数量。）
2．支持软体（如：（1）操作系统名称及版本号；（2）语言编译系统或汇编系统的名称及版本号；（3）资料库管理系统的名称及版本号；（4）其他必要的支持软体。）
四．使用说明
1．安装和初始化（给出程式的存储形式、操作命令、回馈资讯及其含义、表明安装完成的测试实例以及安装所需的软体工具等。）
2．输入（给出输入数据或参数的要求。）
（1）数据背景（说明数据来源、存储媒体、出现频度、限制和品质管理等。）（2）数据格式（如：（1）长度（2）格式基准（3）标号（4）顺序（5）分隔符号（6）辞汇表（7）省略和重复（8）控制。）
（3）输入举例
3．输出（给出每项输出数据的说明。）
（1）数据背景（说明输出数据的去向、使用频度、存放媒体及品质管理等。）（2）数据格式（详细阐明每一输出数据的格式,如:首部主体和尾部的具体形式。）
（3）举例
3．出错和恢复（给出：（1）出错资讯及其含义（2）用户应采取的措施，如修改、恢复、再启动。）
4．求助查询（说明如何操作。）
五．运行说明
1．运行表[列出每种可能的运行情况,说明其运行目的.]
2．运行步骤[按顺序说明每种运行的步骤,应包括:]
（1）运行控制
（2）操作资讯（（1）运行目的（2）操作要求（3）启动方法（4）预计运行时间（5）操作命令格式及说明（6）其他事项。）
（3）输入/输出档（给出建立和更新档的有关资讯，如：（1）档的名称及编号（2）记录媒体（3）存留的目录（4）档的支配[说明确定保留
档或废弃档的准则，分发档的对象，占用硬体的优先顺序及保密控
制等。）
（4）启动或恢复过程
六．非常规过程（提供应急或非常规操作的必要资讯及操作步骤，如出错处理操作、向後备系统切换操作以及维护人员须知的操作和注意事项。）七．操作命令一览表
（按字母顺序逐个列出全部操作命令的格式功能及参数说明。）
八．程式档（或命令档）和数据档一览表（按档案名字母顺序或按功能与模组分类顺序逐个列出档案名称、识别字及说明。）
九．用户操作举例
测试计画（TestPlan）
一、引言
1．编写目的（阐明编写测试计画的目的,指明读者对象。）
2．专案背景（说明专案的来源委托单位及主管部门。）
3．定义（列出测试计画中用到的专门术语定义和缩写词的原意。）
4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）专案的计画任务书，合同或批文；（2）专案开发计画；（3）需求规格说明书；（3）概要设计说明书；（4）详细设计说明书；
（5）用户操作手册;g本测试计画中引用的其他资料采用的软体开发标准或规范。）
二．任务概述
1．目标
2．运行环境
3．需求概述
4．条件与限制
三．计画
1．测试方案（说明确定测试方法和选取测试用例的原则。）
2．测试专案（列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。）
3．测试准备
4．测试机构及人员（测试机构名称负责人和职责。）
四．测试专案说明（按顺序逐个对测试专案做出说明：）
1．测试专案名称及测试内容
2．测试用例
（1）输入（输入的数据和输入的命令。）
（2）输出（预期的输出数据。）
（3）步骤及操作
（4）允许偏差（给出实测结果与预测结果之间允许偏差的范围。）
3．进度
4．条件（给出项测试对资源的特殊要求，如设备、软体、人员等。）
5．测试资料（说明项测试所需的资料。）
五．评价
1．范围（说明所完成的各项测试说明问题的范围及其局限性。）
2．准则（说明评价测试结果的准则。）
测试分析报告（TestSpecification）
一．引言
1．编写目的（阐明编写测试分析报告的目的，指明读者对象。）
2．专案背景（说明专案的来源、委托单位及主管部门。）
3．定义（列出测试分析报告中用到的专门术语定义和缩写词的原意。）4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）专案的计画任务书，合同或批文；（2）专案开发计画；（3）需求规格说明书；（4）概要设计说明书；（5）详细设计说明书；
（6）用户操作手册；（7）测试计画；（8）测试分析报告所引用的其他资料、采用的软体工程标准或软体工程规范。）
二．测试计画执行情况
1．测试专案（列出每一测试专案的名称、内容和目的。）
2．测试机构和人员（给出测试机构名称、负责人和参与测试人员名单。）
3．测试结果（按顺序给出每一测试专案的：（1）实测结果数据（2）与预期结果数据的偏差（3）该项测试说明的事实（4）该项测试发现的问题。）三．软体需求测试结论（按顺序给出每一项需求测试的结论。包括：（1）证实的软体能力（2）局限性（即项需求未得到充分测试的情况及原因）。）四．评价
1．软体能力（经过测试所表明的软体能力。）
2．缺陷和限制（说明测试所揭露的软体缺陷和不足,以及可能给软体运行带来的影响。）
3．建议（提出为弥补上述缺陷的建议。）
4．测试结论（说明能否通过。）
开发进度表（Thedevelopmentschedule）
一．报告时间及所处的开发阶段
二．给出进度
1．主要活动
2．实际进展与计画比较
三．所用工时（按不同层次人员分别计时。）
四．所有机时（按所有电脑机型分别计时。）
五．经费支出（分类列出本月经费支出专案,给出支出总额，并与计画比较。）六．工作遇到的问题及采取的对策
七．本月完成的成果
八．下月的工作计画
九．特殊问题
专案开发简报（Projectpresentations）
一．引言
1．编写目的（阐明编写总结报告的目的,指明读者对象。）
2．专案背景（说明专案的来源、委托单位、开发单位及主管部门。）
3．定义（列出报告中用到的专门术语定义和缩写词的原意。）
4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）专案的计画任务书，合同或批文；（2）专案开发计画；（3）需求规格说明书；（4）概要设计说明书；（5）详细设计说明书；
（6）用户操作手册；（7）测试计画；（8）测试分析报告（9）本报告引用的其他资料、采用的开发标准或开发规范。）
二．开发结果
1．产品（可包括：（1）列出各部分的程式名称、根源程式行数（包括注释行）或目标程式位元组数及程式总计数量、存储形式；产品文档名称等。）2．主要功能及性能
3．所用工时（按人员的不同层次分别计时。）
4．所用机时（按所用电脑机型分别计时。）
5．进度（给出计画进度与实际进度的对比。）
6．费用
三．评价
1．生产率评价（如平均每人每月生产的根源程式行数、文档的字数等。）2．技术方案评价
3．产品品质评价
四．经验与教训
软件开发文档规范
附2: 软件文档编写向导 文档分类 项目包括如下几类文档： 项目管理文档。包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》 软件开发文档。包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。 产品文档。包括：《用户操作手册》《演示文件》。 软件项目计划 （Software Project Plan） 一?引言 1?编写目的（阐明编写软件计划的目的，指出读者对象。） 2?项目背景（可包括：（1 ）项目委托单位、开发单位和主管部门；（2）该软件系统与 其他系统的关系。） 3?定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4?参考资料（可包括：文档所引用的资料、规范等；列出资料的作者、标题、编号、发 表日期、出版单位或资料来源。） 二?项目概述 1.工作内容（简要说明项目的各项主要工作，介绍所开发软件的功能性能等?若不编写可行性研究报告，则应在本节给出较详细的介绍。） 2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的 条件?必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3.产品 （1）程序（列出应交付的程序名称使用的语言及存储形式。） （2）文档（列出应交付的文档。） （3 ）运行环境（应包括硬件环境软件环境。） 4?服务（阐明开发单位可向用户提供的服务?如人员培训安装保修维护和其他运行支持。 5.验收标准
三.实施计划 1.任务分解（任务的划分及各项任务的负责人。） 2?进度（按阶段完成的项目，用图表说明开始时间完成时间。） 3?预算 4?关键问题（说明可能影响项目的关键问题，如设备条件技术难点或其他风险因素，并说明对策。） 四.人员组织及分工 五.交付期限 六.专题计划要点（如测试计划等。） 项目开发进度报告 一.报告时间及所处的开发阶段 二.给出进度 1.本周的主要活动 2.实际进展与计划比较 三.所用工时（按不同层次人员分别计时。） 四.所有机时 五.工作遇到的问题及采取的对策 六.本周完成的成果 七.下周的工作计划 八.特殊问题 项目开发总结报告 一.引言 1.编写目的（阐明编写总结报告的目的，指明读者对象。） 2.项目背景（说明项目的来源、委托单位、开发单位及主管部门。） 3.定义（列出报告中用到的专门术语定义和缩写词的原意。） 4.参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括： （1 ）项目开发计划；（2 ）需求规格说明书；（3 ）概要设计说明书；（4 ）详细设计说明
(国内标准)GB-软件开发主要文档编写规范
231 GB 8567－88软件开发主要文档编写规范 本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。 一、可行性研究报告 l 引言 1.1 编写目的 说明：说明本可行性研究报告的编写目的，指出预期的读者。 1.2 背景 说明： a ．所建议开发的软件系统的名称。 b ．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。 c ．该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料 列出用得着的参考资料，如： a ．本项目的经核准的计划任务书或合同、上级机关的批文。 b ．属干本项目的其他已发表的文件。 c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 可行性研究的前提 说明对建议开发项目进行可行性研究的前提，如要求、目标、条件、假定和限制等。 2.1 要求 说明对所建议开发软件的基本要求，如： a ．功能。 b ．性能。 c ．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象。 d. 输入说明。系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频度。 e ．处理流程和数据流程。用图表的方式表示出最基本的数据流程和处理流程，并输之以叙述。 f. 在安全与保密方面的要求。 g. 同本系统相连接的其他系统。 h. 完成期限。 2.2 目标 说明所建议系统的主要开发目标，如： a. 人力与设备费用的减少。 b. 处理速度的提高。 c. 控制精度或生产能力的提高。
[模板] 软件详细设计说明书编写指南
xxxxxx项目 详细设计说明书编写指南 编写单位
详细设计说明书编写指南变更履历
目录 第一章前言 (4) 1.1编写目的 (4) 1.2文档内容 (4) 第二章详细设计说明书的编写要求 (5) 2.1引言 (5) 2.1.1 编写目的 (5) 2.1.2 背景 (5) 2.1.3 定义 (5) 2.1.4 参考资料 (5) 2.2子系统设计 (5)
第一章前言 1.1 编写目的 本文旨在指导项目建设单位和承建单位编写详细设计说明书，详细设计是软件工程中软件开发的一个步骤，是对概要设计的细化过程。由于各承建单位采用的设计方法不尽相同，本文档提出详细设计阶段必须完成的工作内容，但不限制采用的设计方法和对详细设计成果的展现形式，各承建单位可以根据实际情况自行确定描述方法和展现形式。本文中的示例仅供参考。 1.2 文档内容 本指南主要包含以下内容： 一、描述详细设计说明书的编写要求。 二、举例说明详细设计说明书的编写方法。
第二章详细设计说明书的编写要求 本章节主要描述详细设计说明书的编写要求。详细设计说明书需满足“2.1引言”章节的内容和格式要求；详细设计说明书需满足“2.2章节”的内容要求，不限制格式。 各项目建设单位和承建单位编写详细设计说明书要满足本章的内容要求，不限制格式。 2.1 引言 2.1.1 编写目的 说明编写这份详细设计说明书的目的，指出预期的读者。 2.1.2 背景 描述详细设计阶段的目标、作用范围以及其他应向读者说明的理解本文档所需的背景，如与公司其它软件之间的联系等。 2.1.3 定义 列出本文件中用到专门术语的定义、英文缩写词的原词组和意义、项目组内达成一致意见的专用词汇，同时要求继承全部的先前过程中定义过的词汇。 2.1.4 参考资料 列出有关的参考资料，如： 1、本项目的经核准的计划任务书或合同、上级机关的批文； 2、属于本项目的其他已发表的文件； 3、本文件中各处引用到的文件资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。 2.2 子系统设计 本章描述详细设计阶段对每个模块的设计，包括实现算法、局部数据结构等内容。各项目可根据采用的详细设计方法，以说清楚对每个模块的设计为目的，
软件开发流程
快视信息软件开发流程规范： 用户需求：软件项目首先由客户经理(CM，Custom Management)接洽客户的较大的需求。这时的需求叫市场需求（或叫用户需求），客户经理会进行各个项目的安排，即对项目的启动时间和发布时间进行规划和设置。 项目经理(PM，Project Management)对客户经理负责。项目经理的需求是根据客户经理给的，项目经理不和用户（客户）直接接触（通过客户经理接触），负责和用户进行需求洽谈和沟通的是客户经理。一个项目的需求在一般情况下是不准变更的，如果有需求理解方面的不清楚可以进行沟通，但是需求是不变更的。如果用户有新的需求，一般规划在下一个版本中。因为需求变更了，这个目的时间就要进行调整，就不能按计划进行和完成。客户经理提交给项目经理的是需求规格说明书。 一、项目开工会 在项目经理领到客户经理分配给的需求后，做项目计划，具体做项目人员的确定、需求的分解（需求分解到每个人）、代码量的估计，项目各个阶段时间的划分和工作量的计划、质量指标的设定。这时项目经理需要输出的文档是项目需求分解任务书、项目计划PPT、及做好整个项目需要填写的一系列表格。然后组织项目组成员和客户经理CM、QA(质量审计经理)进行项目开工会。这时这个项目就算真正启动，计算工作量时，即计算这个项目总共花了多少个工时，工时是项目经理做计划的时间也算在内，再加上项目开工会和后续各个阶段总共花的总工时数，还有各个阶段开会所花的时间。在项目开工会上，各个成员就明确了这个项目是属于增强型项目，还是其他项目的项目性质，增强型项目的意思是说在原来上一版本的基础上又根据新的需求进行增强型开发。还有要明确项目最后开发出的新增代码量有多少，最后要明确每个人的需求任务，接下来着手进行SRS的写作。 二、SRS阶段：System/Software Requirment Specification 软件需求规格说明 在项目开工会后，项目组就开始按照在项目开工会上项目经理的需求任务分解的任务开始进行SRS的写作。 一般项目经理给你的一个子需求任务，你这时需要分解为更小的需求。一般一个需求的写作是按这样进行的。先简单介绍这个需求，然后把这个需求设计成黑盒的形式，即输入，处理过程、输出。这些都需要写详细，任何一个需求都写成这种形式，输入是什么，处理过程是什么，输出结果是什么。处理过程需要用Visio或者PPT画出处理流程图，流程图要很详细。每一步的各种情况都要表示和考虑到。对异常情况也要考虑和进行处理。还有要说明在原来的基础上怎么改动，具体方法要进行说明。设计的数据库表结构，要给出脚本，SQL语句，表结构需说明每个字段，哪些是主键，你在这个需求处理过程中哪里使用了哪些表，需要进行哪些操作，都需要说明。这里需要设计和编制《数据库设计说明书》文档。该文档中描述该系统中设计出的所有的数据库表结构和各字段类型。还有多个操作对象要画序列图表示出按时序的处理过程。这个SRS文档就相当于我们平时毕业设计或者一个题目的详细设计阶段达到的水平，甚至比它更详细。每个项目组成员都把自己的需求的SRS文档写出来之后放到配置库中，然后每个人对项目组其他成员的（非自己的）SRS文档进行Review（评审）,对每个SRS文档在每页发现或者纠正的错误数不能低于一定的数目，而且要保留批注记录，经过Review的（保留批注的）文档要放到配置库的Review文件夹下，这是进行项目质量指标收集的重要依据，是QA 进行调阅和审计的资料。项目经理要对SRS文档、SRS Review文档进行汇总。在汇总后组织项目组全体成员进行SRS阶段会议，对每个人写的SRS进行评审会议（讨论和提意见），对别人给你提的修改意见你要一一进行说明，说明为什么不改，怎么改的，是什么问题，问题严重程度属于什么级别，而且都要填表，也是QA进行审计的内容。开完会后如果每个人完成的都差不多，然后安排半天或者一天的时间进行返工，主要是进行修改文档，按在会上讨论的结果和别人给你的Review 文档结果（评审结果）进行准一修改和完善。然后再进行SRS阶段开会，如果都做的比较到位和具体、符合要求，即关闭SRS阶段。这时SRS阶段的花费的工时数和一些质量活动指标就出来了，比如你这个SRS文档写了几页，每页的错误数是多少，返工修改用了多少时间，然后这些这个比率也会自动计算出来。进而可以判断这个阶段的质量。每个项目组成员在每天工作完毕后都要进行Time Sheet 的填写，必须具体到半个小时，这是统计和分析的需要。填写必须真实。 三、UTP、STP阶段（UTP、STP写作） UTP Unit Test Plan 单元测试计划 STP System Test Plan
软件开发 软件产品开发文件编制指南
附录五国家标准《计算机软件产品开发文件编制指南》国家标准《计算机软件产品开发文件编制指南》（GB 8567—88）是一份指导性文件。它建议在软件的开发过程申编下述14个文件：可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、总体设计说明书、详细设计说明、数据库设计说明书、用户手册、操作手册、模块开发卷、测试计划、测试分析报告、开发进度表、项目开发总结。该指南给出了这14个文件的编制提示，它同时也是这14个文件编写质量的检验准则。下面详细介绍这14种文件的编写目的与内容要求。 l、可行性研究报告 可行性研究报告的目的是：说明该软件开发项目的实现在技术上、经济上和社会条上的可行性，论述为了合理地达到开发目标而可能选择的各种方案，说明并论证所选定的方案。可行性研究报告的编写内容见表l。 表l 可行性研究报告 2、项目开发计划 编制项目开发计划的目的是用文件的形式，并在开发过程中各项工作的
负责人员、开发进度、经费预算、所需软硬件条件等问题做出的安排记录下来，以便根据本计划开展和检查项目的开发工作。编制内容要求如表2所示。 表 2 项目开发计划 3、软件需求说明书 软件需求说明书的编制是为了使用户和软件开发人员双方对该软件的初始规定有一个共同的理解， 使之成为整个软件开发工作的基础。其内容要求见表3。 表3 软件需求说明书 4、数据要求说明书 数据要求说明书的编制目的是为了向整个软件开发时期提供关于被处理数据的描述和数据采集要求的技术信息，其内容要求列于表4中。 表4 数据要求说明书
5、概要设计说明书 概要设计说明书又称为总体设计说明书，编制目的是说明对项目系统的设计考虑，包括基本处理流程、组织结构、模块结构、功能配置、接口设计、运行设计、系统配置、数据结构设计和出错处理设计等，为程序的详细设计提供基础。其内容要求见表5。 表5 概要设计说明书 6、详细设计说明书 详细设计说明书又称为程序设计说明，编制目的是说明一个软件系统各个层次中的每一个程序（模块）的设计考虑。 如果软件系统比较简单，层次少，本文件可以不单独编写，有关内容可并入概要设计说明书。详细设计说明书的内容要求见表6。 表6 详细设计说明书 7、数据库设计说明书
软件开发文档说明书(完整流程)
. 在软件行业有一句话：一个软件能否顺利的完成并且功能是否完善，重要是看这个软件有多少文档，软件开发文档是一个软件的支柱，如果你的开发文档漏洞百出，那么你所开发出来的软件也不可能会好；开发文档的好坏可以直接影响到所开发出来软件的成功与否。 一、软件开发设计文档：软件开发文档包括软件需求说明书、数据要求说有书、概要设计说明书、详细设计说明书。 1、软件需求说明书：也称为软件规格说明。该说明书对所开发软件的功能、性能、用户界面及运行环境等做出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。软件需求说明书的编制目的的就是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解、并使之面成为整个开发工作的基础。 其格式要求如下： 1 引言 1．1 编写目的。 1．2 背景 1．3 定义 2 任务概述 2．1 目标 2．2 用户的特点
. 2．3 假定和约束 3 需求规定 3．1 对功能的规定 3．2 对性能的规定 3．2．1 精度 3．2．2 时间特性的需求 3．2．3 灵活性 3．3 输入输出要求 3．4 数据管理能力要求 3．5 故障处理要求 3．6 其他专门要求 4 运行环境规定 4．1 设备 4．2 支持软件 4．3 接口 4．4 控制
. 2、概要设计说明书：又称系统设计说明书，这里所说的系统是指程序系统。编制的目的是说明对程序系统的设计考虑，包括程序系统的基本处理。流程、程序系统的组织结构、模块划分、功能分配、接口设计。运河行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。 其格式要求如下： 1 引言 1．1 编写目的 1．2 背景 1．3 定义 1．4 参考资料 2 总体设计 2．1 需求规定 2．2 运行环境 2．3 基本设计概念和处理流程 2．4 结构 2．5 功能需求与程序的关系
软件文档编写指南
《计算机软件文档编写指南》 一．计算机软件文档由封面、目录、正文、注释和附录组成。 封面格式： 密级：编号： 文档名称： 项目名称： 编制： 审核： 批准： ×××××××××××××研究所 年月日
二．计算机软件文档包括： 1）软件开发计划 2）软件需求规格说明 3）接口需求规格说明 4）接口设计文档 5）软件设计文档 6）软件产品规格说明 7）版本说明文档 8）软件测试计划 9）软件测试说明 10）软件测试报告 11）计算机系统操作员手册 12）软件用户手册 13）软件程序员手册 14）计算机资源综合保障文件 软件开发计划 一．引言 1．编写目的（阐明编写软件计划的目的，指出读者对象。） 2．项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。） 3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（可包括：（1）项目经核准的计划任务书、合同或上级机关的批文；（2）文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．项目概述 1.工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 若不编写可行性 研究报告,则应在本节给出较详细的介绍。) 2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件. 必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3.产品 （1）程序（列出应交付的程序名称使用的语言及存储形式。） （2）文档（列出应交付的文档。） （3）运行环境（应包括硬件环境软件环境。） 4．服务（阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。）
ISO软件开发全套文档~软件开发过程控制程序
北京易游无限科技公司 https://www.sodocs.net/doc/e5121560.html, EUWX/QP 0714 软件开发过程控制控制程序 授控状态： 版号：A/O 分发号： 持有人： 2007年8月6日发布2007年8月6日实施
易游无限科技发布 易游无限科技程序文件文件编号CSI/QP 0714 版号A/0 标题: 软件开发过程控制程序页码共5页第1页
为保证软件产品及其文档可维护，软件开发过程得到有效控制，特制定本程序。 2适用范围 本程序文件适用于本公司有合同的所有软件开发过程的控制活动。 3定义 3．1需求分析：（引用GB/T11457-1995的2.404）研究用户要求以得到系统或软件需求定义的过程。 3．2概要设计：（引用GB/T11457-1995的2.343）分析各种设计方案和定义软件体系结构的过程。典型的概要设计包括计算机程序组成成分和数据的定义及构造、界面的定义，并提出时间和规模方面的估计。 3．3详细设计：（引用GB/T11457-1995的2.147）推敲并扩充概要设计，以获得关于处理逻辑、数据结构和数据定义的更加详尽的描述，直到设计完善到足以能实现的地步。 3．4设计实现：（引用GB/T11457-1995的2.229）把设计翻译成代码，然后对此代码排除隐错的过程。它是程序的一种机器可执行形式，或者能被自动地翻译成机器可执行的形式的某种形式的程序。 4职责 4．1项目负责人：负责制订《项目计划》、协调项目内外各方的关系、控制项目进度并保证项目计划的实施和完成。 4．2需求分析员：作为开发方的代表，负责沟通用户和开发人员的认识和见解，明确及准确地编写《软件需求说明书》和初步的《系统指南》。 4．3系统设计员：负责把软件需求变换成可表示的可实现的软件形式，为设计实现提供可行的依据。并在设计过程中要负责编写《概要设计说明书》、《数据库设计说明书》、《详细设计说明书》，完成《系统指南》的编写。 4．4程序员：按设计要求把软件的详细设计变换成可执行的源程序，进行调试。完成相应的文档，编写《用户操作手册》。 4．5测试人员：负责制定测试计划，设计测试方案，测试用例，并实施测试。 4．6配置管理人员负责对开发库中软件配置项的管理和维护。 4工作程序 软件开发过程主要分为项目计划、需求分析、概要设计、详细设计、设计实现、内部测试和系统测试7个阶段。 易游无限科技程序文件文件编号CSI/QP 0714 版号A/0 标题: 软件开发过程控制程序页码共5页第2页
系统详细设计说明书
文档标题 文档编号BH-CSD-003 版本V1.0 密级商密 A 研发生产中心项目名称全科医生专家咨询系统 项目来源 系统详细设计说明书 （V1.0 ） 南京毗邻智慧医疗科技有限公司 二○一三年十一月
文档变更记录 序号变更（ +/- ）说明作者版本号日期批准1 创建Steve.ma V1.0 2013.11.15 1 引言.......................................................................... (3) 1.1 编写目 的 ......................................................................... (3) 1.2 背 景 .......................................................................... (3) 1.3 定 义 .......................................................................... (3) 1.4 参考资 料 ......................................................................... (4) 2 平台安全体系与程序系统的结构........................................................................................ (4) 2.1 平台安全体 系 ........................................................................ (4) 2.2 程序系统结 构 ........................................................................ (5) 3 程序设计说 明 ........................................................................... (5) 3.1 程序描 述 ......................................................................... (5) 功能及其接 口 ........................................................................
一个完整的软件开发流程
一个完整的软件开发流程 一、开发流程图 二、过程产物及要求 本表主要列出开发阶段需要输出的过程产物，包括产物名称、成果描述、负责人及备注，即谁、在什么时间、应该提供什么内容、提供内容的基本方向和形式是什么。 三、过程说明 (一)项目启动 1、产品经理和项目干系人确定项目方向，产品型项目的干系人包括公司领导、产品总监、技术总监等，项目的话则包括客户方领导、主要执行人等。
2、公司领导确认项目组团队组成，包括产品经理、研发项目经理、研发工程师、测试团队等。 3、明确项目管理制度，每个阶段的成果产物需要进行相应的评审，评审有相应的《会议纪要》;从项目启动起，研发项目经理每周提供《项目研发周报》;测试阶段，测试工程师每周提供《项目测试周报》。 4、产品经理进行需求调研，输出《需求调研》文档。需求调研的方式主要有背景资料调查和访谈。 5、产品经理完成《业务梳理》。首先，明确每个项目的目标;其次，梳理项目涉及的角色;再来，每个角色要进行的事项;最后，再梳理整个系统分哪些端口，要有哪些业务模块，每个模块再包含哪些功能。 (二)需求阶段 1、进入可视化产物的输出阶段，产品经理提供最简单也最接近成品的《产品原型》，线框图形式即可。在这个过程中还可能产生的包括业务流程图和页面跳转流程图。业务流程图侧重在不同节点不同角色所进行的操作，页面跳转流程图主要指不同界面间的跳转关系。项目管理者联盟 2、产品经理面向整个团队，进行需求的讲解。 3、研发项目经理根据需求及项目要求，明确《项目里程碑》。根据项目里程表，完成《产品开发计划》，明确详细阶段的时间点，最后根据开发计划，进行《项目任务分解》，完成项目的分工。 4、研发工程师按照各自的分工，进入概要需求阶段。《概要需求》旨在让研发工程师初步理解业务，评估技术可行性。 (三)设计阶段 1、UI设计师根据产品的原型，输出《界面效果图》，并提供界面的标注，最后根据主要的界面，提供一套《UI设计规范》。UI设计规范主要是明确常用界面形式尺寸等，方便研发快速开发。UI设计常涵盖交互的内容。 2、研发工程师在界面效果图，输出《需求规格》，需求规格应包含最终要实现的内容的一切要素。 3、研发工程师完成《概要设计》、《通讯协议》及《表结构设计》，及完成正式编码前的一系列研发设计工作。 (四)开发阶段项目经理博客 1、研发工程师正式进入编码阶段，这个过程虽然大部分时间用来写代码，但是可能还需要进行技术预研、进行需求确认。
软件编写指南
软体文档编写指南 封面格式： 文档编号 版本号 文档名称： 专案名称： 专案负责人： 编写年月日 校对年月日 审核年月日 批准年月日 开发单位 系统规约说明书（SystemSpecification） 一．引言 A.文档的范围和目的 B.概述 1．目标 2．约束 二．功能和数据描述 A.系统结构 1．结构关系图 2．结构关系图描述 三．子系统描述 A.子系统N的结构图规约说明 B.结构字典 C.结构连接图和说明 四．系统建模和模拟结构 A.用於模拟的系统模型 B.模拟结果 C.特殊性能 五．软体专案问题 A.软体专案可行性研究报告 B.软体专案计画 六．附录 软体专案可行性研究报告（ReportforFeasibilityStudy）一．引言 1．编写目的（阐明编写可行性研究报告的目的，指出读者对象）
2．专案背景（应包括：（1）所建议开发的软体名称；（2）专案的任务提出者、开发者、用户及实现单位；（3）专案与其他软体或其他系统的关系。） 3．定义（列出文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。） 二．可行性研究的前提 1．要求（列出并说明建议开发软体的基本要求，如（1）功能；（2）性能；（3）输出；（4）输入； （5）基本的数据流程和处理流程；（6）安全与保密要求；（7）与软体相关的其他系统；（8）完成期限。） 2．目标（可包括：（1）人力与设备费用的节省；（2）处理速度的提高；（3）控制精度和生产能力的提高；（4）管理资讯服务的改进；（5）决策系统的改进；（6）人员工作效率的提高，等等。） 3．条件、假定和限制（可包括：（1）建议开发软体运行的最短寿命；（2）进行系统方案选择比较的期限；（3）经费来源和使用限制；（4）法律和政策方面的限制；（5）硬体、软体、运行环境和开发环境的条件和限制；（6）可利用的资讯和资源；（7）建议开发软体投入使用的最迟时间。） 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．指出 （1）基建投资 （2）其他一次性支出 （3）经常性支出
ISO软件开发全套文档-配置管理计划编写指南
产品/项目系统名称 配置管理计划 北京XXXX有限公司 200 年××月 1引言 1.1编写目的
编写的目的主要在于对所开发的软件系统规定各种必要的配置管理条款，以保证所开发出的软件能满足用户需求。 1.2背景 a.开发的软件系统的名称 列出本软件系统的中文全称、英文全称及英文表示简称。 b.开发的软件系统的最终用户或适用的领域； c.项目来源、主管部门等 1.3定义 列出本文件中涉及的专门术语定义和外文缩写的原词组。 1.4参考资料 列出涉及的参考资料。 2 管理 描述软件配置管理的机构、任务、职责和有关的接口控制。 2.1 机构 描述软件生存周期中各阶段中软件配置管理的功能和负责软件配置管理的机构。 说明项目和自项目与其他有关项目之间的关系。 指出在软件生存周期各阶段中的软件开发或维护机构与配置控制组的关系。 2.2 任务 描述在软件生存周期中各阶段的配置管理任务以及要进行的评审和检查工作，并指出各阶段的阶段产品应存放在哪一类软件库中（软件开发库、软件受控制库或软件产品库）。 2.3 职责 指出负责各项软件配置管理任务（如配置标识、配置控制、配置状态记录以及配置的评审与检查）的机构的职责； 指出上述机构与软件质量保证机构、软件开发单位、项目承办单位、项目委托单位以及用户等机构的关系。 说明软件生存周期各个阶段的评审、检查和审批过程中的用户职责以及相关的开发与维护活动。 指出与项目开发有关的各机构的代表的软件配置管理职责。 指出与其他特殊职责，例如为满足软件配置管理要求所必要的批准要求。 2.4 定义软件配置项（SCI） 包括： 1．系统约定 2．软件项目计划 3．软件需求文档 4．用户手册 5．设计文档
软件需求规格说明编写指南(438B)
密级： （软件项目名称） 软件需求规格说明 标 识： 版 本： 页 数： 拟 制： SQA 审核： 审 核： 批 准： 拟制部门： 年 月 日
修改文档历史记录： 日期版本说明修改人
目录 1 范围 (1) 标识 (1) 系统概述 (1) 文档概述 (1) 2 引用文档 (2) 3 需求 (2) 要求的状态和方式 (2) CSCI能力需求 (5) （CSCI能力） (5) 6 注释 (10)
1 范围 标识 【本条应描述本文档所适用的系统和软件的完整标识，适用时，包括其标识号、名称、缩略名、版本号及发布号。】 示例： 系统标识如下： a)已批准的标识号： b)产品名称：XXXXXX c)产品代号：XXXXXX d)版本号：XXXXX e)缩略名： 系统概述 【本条应概述本文档所适用的系统和软件的用途。它还应描述系统与软件的一般特性；概述系统开发、运行和维护的历史；标识项目的需方、用户、开发方和保障机构；标识当前和计划的运行现场；列出其它有关文档。】 示例： a) 软件用途： b) 系统概述： c) 需方：XXXXX d) 开发方：软件开发组 e) 运行环境：XXXXX f) 相关文档： 以下描述相关技术数据内容: 1) 软件开发计划 2) 软件研制任务书 3) 。。。 文档概述 【本条应概述文档的用途和内容，并描述与它的使用有关的保密性方面的要求。】
2 引用文档 【本章应列出引用文档的编号、标题、编写单位、修订版及日期，还应标识所有不能通过正常采购活动得到的文档的来源。】 3 需求 要求的状态和方式 【如果要求CSCI在多种状态或多种方式下运行，并且不同的状态或方式具有不同的需求，则应标识和定义每一种状态和方式。状态和方式的例子包括：空闲、就绪、活动、事后分析、训练、降级、紧急情况、备份、战时和平时等。可以仅用状态描述CSCI，也可仅用方式、用方式中的状态、状态中的方式、或其他有效的方式描述CSCI。如果不需要多种状态或方式，应如实陈述，而不需要进行人为的区分；如果需要多种状态和/或方式，应使本规格说明中的每个或每组需求与这些状态和方式相对应，对应关系可以在本条或本条所引用的附录中，通过表格或其它方式加以指明，也可以在该需求出现的章条中加以声明。】 示例：
软件开发过程规范
【最新资料,Word版，可自由编辑！】
目录 1.前言............................................................................................................................................... 1.1目的.......................................................................................................................................... 1.2对象.......................................................................................................................................... 1.3要求.......................................................................................................................................... 1.4适用范围.................................................................................................................................. 1.5软件开发过程模型................................................................................................................. 1.6开发过程划分 ......................................................................................................................... 2.技术过程规范部分...................................................................................................................... 2.1概述.......................................................................................................................................... 2.2业务建模阶段 ......................................................................................................................... 2.3需求阶段.................................................................................................................................. 2.4分析设计阶段 ......................................................................................................................... 2.5实现阶段.................................................................................................................................. 3.管理过程规范部分...................................................................................................................... 3.1概述.......................................................................................................................................... 3.2接受项目.................................................................................................................................. 3.3重新评估项目范围和风险（对于较大项目） ................................................................... 3.4制定开发计划 ......................................................................................................................... 3.5迭代开发管理 ......................................................................................................................... 3.6监控项目的实施 ..................................................................................................................... 3.7结束项目..................................................................................................................................
软件开发设计文档模板
软件文档编写指南 封面格式： 文档编号 版本号 文档名称： 项目名称： 项目负责人： 编写年月日 校对年月日 审核年月日 批准年月日 开发单位 系统规约说明书（System Specification） 一．引言 A.文档的范围和目的 B.概述 1．目标 2．约束 二．功能和数据描述 A.系统结构 1．结构关系图 2．结构关系图描述 三．子系统描述 A.子系统N的结构图规约说明 B.结构字典 C.结构连接图和说明 四．系统建模和模拟结构 A.用于模拟的系统模型
B.模拟结果 C.特殊性能 五．软件项目问题 A.软件项目可行性研究报告 B.软件项目计划 六．附录 软件项目可行性研究报告（Report for Feasibility Study） 一．引言 1．编写目的（阐明编写可行性研究报告的目的，指出读者对象） 2．项目背景（应包括：（1）所建议开发的软件名称；（2）项目的任务提出者、开发者、用户及实现单位；（3）项目与其他软件或其他系统的关系。） 3．定义（列出文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．可行性研究的前提 1．要求（列出并说明建议开发软件的基本要求，如（1）功能；（2）性能；（3）输出；（4）输入；（5）基本的数据流程和处理流程；（6）安全与保密要求；（7）与软件相关的其他系统；（8）完成期限。） 2．目标（可包括：（1）人力与设备费用的节省；（2）处理速度的提高；（3）控制精度和生产能力的提高；（4）管理信息服务的改进；（5）决策系统的改进；（6）人员工作效率的提高，等等。） 3．条件、假定和限制（可包括：（1）建议开发软件运行的最短寿命；（2）进行系统方案选择比较的期限；（3）经费来源和使用限制；（4）法律和政策方面的限制；（5）硬件、软件、运行环境和开发环境的条件和限制；（6）可利用的信息和资源；（7）建议开发软件投入使用的最迟时间。） 4．可行性研究方法 5．决定可行性的主要因素 三．对现有系统的分析 1．处理流程和数据流程 2．工作负荷 3．费用支出（如人力、设备、空间、支持性服务、材料等项开支。） 4．人员（列出所需人员的专业技术类别和数量。） 5．设备 6．局限性（说明现有系统存在的问题以及为什么需要开发新的系统。） 四．所建议技术可行性分析 1．对系统的简要描述 2．处理流程和数据流程 3．与现有系统比较的优越性 4．采用建议系统可能带来的影响 （1）对设备的影响 （2）对现有软件的影响
软件架构设计说明书
目录
1.引言 [对于由多个进程构成的复杂系统，系统设计阶段可以分为：架构设计（构架设计）、组件高层设计、组件详细设计。对于由单个进程构成的简单系统，系统设计阶段可以分为：系统概要设计、系统详细设计。本文档适用于由多个进程构成的复杂系统的构架设计。] [架构设计说明书是软件产品设计中最高层次的文档，它描述了系统最高层次上的逻辑结构、物理结构以及各种指南，相关组件（粒度最粗的子系统）的内部设计由组件高层设计提供。] [系统：指待开发产品的软件与硬件整体，其软件部分由各个子系统嵌套组成，子系统之间具有明确的接口； 组件：指粒度最粗的子系统； 模块：指组成组件的各层子系统，模块由下一层模块或函数组成；] [此文档的目的是： 1）描述产品的逻辑结构，定义系统各组件（子系统）之间的接口以及每个组件（子系统）应该实现的功能； 2）定义系统的各个进程以及进程之间的通信方式； 3）描述系统部署，说明用来部署并运行该系统的一种或多种物理网络（硬件）配置。对于每种配置，应该指出执行该系统的物理节点（计算机、网络设备）配置情况、节点之间 的连接方式、采用何种通信协议、网络带宽。另外还要包括各进程到物理节点的映射； 4）系统的整体性能、安全性、可用性、可扩展性、异常与错误处理等非功能特性设计； 5）定义该产品的各个设计人员应该遵循的设计原则以及设计指南，各个编程人员应该遵循的编码规范。 ] [建议架构设计工程师与组件设计工程师共同完成此文档。] [架构设计说明书的引言应提供整个文档的概述。它应包括此文档的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述。] 1.1目的 [简要描述体系结构文档的目的。]