软件开发规范
Software Development Specification Version: V1.0
Date: 2010-06-22
Prepared by
Document Revision History文档修订记录
Table of Contents目录
1Introduction 简介5
1.1Purpose 目标5
1.2Scope 范围6
1.3Definitions, Acronyms, and Abbreviations. 术语，缩略词6
1.4References 引用7
1.5Overview 文档组织7 2The Overall Description 概述8
2.1Software Development Organizing 开发团队组织结构8
2.2Project Base Process 项目基本流程9
2.3CMM Base Process CMM基本过程10
2.3.1SCM软件配置管理10
2.3.2SPP 计划策划12
2.3.3SPTO项目追踪15
2.3.4PR同行评审17
2.3.5SQA质量保证18
2.4SDLC 生命周期选择19
2.5Development Process 开发过程20
2.5.1Development Phase 开发阶段20
2.5.2Phase Product 阶段制品21
2.6Role Duty 角色职责22
2.7Constraints 限制23 3Specific Requirements 详细描述24
3.1Precondition 前提24
3.1.1SCM配置库24
3.1.2Test Environment 测试环境25
3.2Development Control Process 开发控制流程25
3.2.1项目启动和策划阶段26
3.2.2需求分析、设计、编码阶段26
3.2.3提交测试阶段26
3.2.4生产发布、终测27
3.2.5发布后问题反馈修改过程27
3.3TSP 团队软件过程29
3.3.1会议组织29
3.3.2沟通问题29
3.3.3代码走查29
3.3.4其它30
3.4PSP 个人软件过程30
3.4.1工作原则30
3.4.2日常工作30
3.4.3DE 开发工程师31
3.4.4SCME 配置管理员32
3.4.5DBA 数据库管理员32
3.4.6Deployer 发布人员33 4Tool Specification 工具规范33
4.1通用工具33
4.2计划33
4.3需求分析34
4.4设计34
4.5编码34
4.6测试34 5Documents 文档35
5.1项目管理文档35
5.1.1项目策划35
5.1.2项目追踪35
5.1.3质量保证35
5.1.4项目终止35
5.2开发过程文档36
5.2.1软件配置管理36
5.2.2会议管理36
5.2.3计划跟踪36
5.2.4评审管理36
5.2.5质量管理36
5.2.6测试过程37
5.2.7问题解决过程37
5.2.8其他37 6Appendix 附录37
6.1易于理解的代码37
6.2Log输出37
1Introduction 简介
一个成熟稳定的组织或者团队，能够减少风险，经常地成功地达成目标。成功的含义是：按时、预算内【即符合成本要求】、符合质量要求。换言之，成熟稳定的团队，能够避免以下问题：
组织方面出现问题
对需求缺乏管理
缺乏计划和控制
估算错误
同时，还要在以下几个方面做得比较出色：
人员调度与工作安排
工作量估计
预算管理
责权分配与平衡
执行与监控
沟通
本文档是软件开发规范，力求使团队打下一个良好的基础，以便逐步成长为成熟稳定的团队。团队需要一个逐步标准、规范的开发过程，在这个过程中，团队得到锻炼，成员能力得到提高，风险得到控制。
主要内容是：
定义软件开发的流程；
定义软件开发的文档格式；
定义涉及的角色；
定义涉及的信息；
描述开发流程；
1.1Purpose 目标
本文档的目标是：
统一软件开发团队的流程、文档；
促进团队成员的沟通，减少误解；
促使程序员书写易维护的代码；
提高代码编写效率；
使每个成员成为一个高效的程序员；
1.2Scope 范围
本文档，包含：
项目管理的流程；
?项目策划
?项目追踪
?配置管理
?质量保证
?同行评审
涉及文档；
?项目计划mpp
?需求规格说明书SRS
?Delphi估算
?项目状态报告
?配置库样式
?CheckList
?评审表
?变更申请表
开发工具的规范；
?数据库设计工具
?功能设计工具
?IDE
?配置工具
1.3Definitions, Acronyms, and Abbreviations. 术语，缩略词
SPP 项目策划Software Project Planning
SPTO 项目追踪Software Project Tracking & Oversight
SCM 配置管理Software Configuration Management
SQA 质量保证Software Quality Assurance
PR 同行评审Peer Review
BaseLine 基线
SCCB 软件配置控制委员会Software Configuration Control Board CR 变更请求Change Request
SDLC 软件开发生命周期Software Development Life Cycle
RUP 统一开发过程Rational Unified Process
XP 极限【敏捷方法】eXtreme Programming
TDD 测试驱动Test Driven Development
1.4References 引用
《CMM2》
《CMM3》
1.5Overview 文档组织
本文档主要分为四大部分：
概述；
描述了团队组织开发过程的高层视图； TSP和PSP；
按照团队和个人描述流程规范；
工具规范；
描述了开发工具的详细规范；
文档；
涉及的文档格式；
软件开发规范 1 排版 11-1：程序块要采用缩进风格编写，缩进的空格数为4个。 说明：对于由开发工具自动生成的代码可以有不一致。 11-2：相对独立的程序块之间、变量说明之后必须加空行。 示例：如下例子不符合规范。 if (!valid_ni(ni)) { ... epssn_index; repssn_ni = ssn_data[index].ni; 应如下书写 if (!valid_ni(ni)) { ... epssn_index; repssn_ni = ssn_data[index].ni; 11-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 示例： = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof( _UL ); act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied
= stat_poi[index].occupied; act_task_table[taskno].duration_true_or_false = SYS_get_sccp_statistic_state( stat_item ); report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER) && (n7stat_stat_item_valid (stat_item)) && (act_task_table[taskno].result_data != 0));
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. 控制精度或生产能力的提高。
软件开发规范 1 排版 1-1：程序块要采用缩进风格编写，缩进的空格数为4个。 说明：对于由开发工具自动生成的代码可以有不一致。 1-2：相对独立的程序块之间、变量说明之后必须加空行。 示例：如下例子不符合规范。 if (!valid_ni(ni)) { ... epssn_index; repssn_ni = ssn_data[index].ni; 应如下书写 if (!valid_ni(ni)) { ... epssn_index; repssn_ni = ssn_data[index].ni; 1-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 示例： = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof( _UL ); act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied = stat_poi[index].occupied; act_task_table[taskno].duration_true_or_false = SYS_get_sccp_statistic_state( stat_item ); report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER) && (n7stat_stat_item_valid (stat_item)) && (act_task_table[taskno].result_data != 0));
软件开发规范 Software Development Specification Version: V1.0 Date: 2010-06-22 Prepared by
Document Revision History文档修订记录
Table of Contents目录 1Introduction 简介5 1.1Purpose 目标5 1.2Scope 范围6 1.3Definitions, Acronyms, and Abbreviations. 术语，缩略词6 1.4References 引用7 1.5Overview 文档组织7 2The Overall Description 概述8 2.1Software Development Organizing 开发团队组织结构8 2.2Project Base Process 项目基本流程9 2.3CMM Base Process CMM基本过程10 2.3.1SCM软件配置管理10 2.3.2SPP 计划策划12 2.3.3SPTO项目追踪16 2.3.4PR同行评审18 2.3.5SQA质量保证19 2.4SDLC 生命周期选择20 2.5Development Process 开发过程21 2.5.1Development Phase 开发阶段21 2.5.2Phase Product 阶段制品22 2.6Role Duty 角色职责23 2.7Constraints 限制24 3Specific Requirements 详细描述25 3.1Precondition 前提25 3.1.1SCM配置库25 3.1.2Test Environment 测试环境26 3.2Development Control Process 开发控制流程26 3.2.1项目启动和策划阶段27 3.2.2需求分析、设计、编码阶段27 3.2.3提交测试阶段27 3.2.4生产发布、终测28 3.2.5发布后问题反馈修改过程28 3.3TSP 团队软件过程30 3.3.1会议组织30 3.3.2沟通问题30 3.3.3代码走查30
附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 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. 控制精度或生产能力的提高。
《计算机软件文档编写指南》 一．计算机软件文档由封面、目录、正文、注释和附录组成。 封面格式： 密级：编号： 文档名称： 项目名称： 编制： 审核： 批准： ×××××××××××××研究所 年月日
二．计算机软件文档包括： 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．服务（阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。）
软件项目开发和管理规范 版本V1.0 2010年1月15日
目录 1.软件项目管理概述 (3) 2.软件项目管理过程 (3) 3.软件项目管理内容 (5) 3.1.需求阶段管理 (5) 3.2.设计阶段管理 (7) 3.3.开发阶段管理 (7) 3.4.测试阶段管理 (8) 3.5.维护阶段管理 (8) 3.6.工具管理 (8) 3.7.软件项目估算与进度管理 (9) 3.7.1.软件项目估算 (9) 3.7.2.进度安排 (10)
1.软件项目管理概述 软件项目管理是软件工程和项目管理的交叉学科，软件项目管理的概念涵盖了管理软件产品开发所必须的知识、技术及工具。根据美国项目管理协会PMI 对项目管理的定义可以将软件项目管理定义为：在软件项目活动中运用一系列知识、技能、工具和技术，以满足软件需求方的整体要求。 软件项目管理是为了使软件项目能够按照预定的成本、进度、质量顺利完成，而对成本、人员、进度、质量、风险等进行分析和管理的活动。实际上，软件项目管理的意义不仅仅如此，进行软件项目管理有利于将开发人员的个人开发能力转化成企业的开发能力，企业的软件开发能力越高，表明这个企业的软件生产越趋向于成熟，企业越能够稳定发展。 软件生存周期包括可行性分析与项目开发计划、需求分析、设计（概要设计和详细设计）、编码、测试、维护等活动，所有这些活动都必须进行管理，在每个阶段都存在着权限角色控制、文档管理、版本控制、管理工具等，软件项目管理贯穿于软件生命的演化过程之中。 2.软件项目管理过程 为保证软件项目获得成功，必须对软件开发项目的工作范围、要完成的任务、需要的资源、需要的工作量、进度的安排、可能遇到的风险等做到心中有数。软件项目的管理工作开始于技术工作开始之前，在软件从概念到实现的过程中持续进行，最后终止于软件开发工作结束。 根据公司的实际情况，结合软件工程及软件过程标准等，特制定我公司软件项目管理流程如下：
软件项目开发计划规范 1 引言 1.1编写目的 ? 阐明开发本软件的目的； ? 说明编写这份项目开发计划的目的； ? 指明软件需求说明书所预期的读者。 1.2背景 ? 表示待开发的软件系统的名称、代码； ? 列出本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络； ? C.说明该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4参考资料 列出用得着的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 项目概述 2.1 工作内容 简要地说明在本项目的开发中须进行的各项主要工作。 2.2主要参加人员 扼要说明参加本项目开发工作的主要人员的情况，包括他们的技术水平。 2.3产品 2.3.1程序 列出需移交给用户的程序的名称、所用的编程语言及存储程序的媒体形式，并通过引用有关文件，逐项说明其功能和能力。 2.3.2文件 列出需移交给用户的每种文件的名称及内容要点。 2.3.3服务 列出需向用户提供的各项服务，如培训安装、维护和运行支持等，应逐项规定开始日期、所提供支持的级别和服务的期限。 2.3.4非移交的产品 说明开发集体应向本单位交出但不必向用户移交的产品（文件甚至某些程序）。 2.4验收标准 对于上述这些应交出的产品和服务，逐项说明或引用资料说明验收标准。 2.5完成项目的员迟用限 2.6本计划的批准者和批准日期 3实施计划 3.1工作任务的分门与人员分工
软件开发文档模板库 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。 可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案1
1.5.2 可选择的系统方案2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资 1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题
软 件 开 发 流 程 规 范 德联软件有限责任公司 编制人：侯秀美审核人： 2015 年 8 月 19 日
目录 目录 .........................................................错误!未定义书签。 一、概述......................................................错误!未定义书签。 二、开发流程规范..............................................错误!未定义书签。 系统软硬件开发环境........................................错误!未定义书签。 系统架构（系统组成）......................................错误!未定义书签。 系统功能模块设计..........................................错误!未定义书签。 系统功能开发流程图........................................错误!未定义书签。 开发修改记录..............................................错误!未定义书签。 三、开发代码规范..............................................错误!未定义书签。 文件结构..................................................错误!未定义书签。 文件信息声明..........................................错误!未定义书签。 程序风格..................................................错误!未定义书签。 空行..................................................错误!未定义书签。
目录 软件开发标准化工作流程 1引言 1.1编写目的 说明编写这份软件开发标准化工作流程的目的，指出预期的读者。 1.2适用范围 互联网开发中心所有项目。 1.3定义 列出本文件中用到的专门术语的定义、外文首字母组词的原词组。
1.4流程图 2需求调研 2.1概述 需求调研对于一个应用软件开发来说，是一个系统开发的开始阶段，需求调研的质量对于一个应用软件来说，是一个极其重要的阶段，它的质量在一定程度上来说决定了一个软件的交付结果。怎样从客户中听取用户需求、分析用户需求就成为调研人员最重要的任务。
2.2需求调研 总体而言，需求调研可按照业务流程、业务规则、表单数据、贯穿系统的关系四个方向来进行调研。 ●业务规则 各个流程、功能点等事项的办理，都会有相关约束或条件，那么需要对其前置条件、后置条件、数据验证、条件判断等进行分析调研。调研对象一般为操作员。 ●表单数据 对各个功能点的业务数据、数据项、表单格式、查询条件以及其它相关数据进行明确的分析调研。调研对象一般为操作员。 ●贯穿系统的关系 各个模块或科室之间的数据交换、传递以及数据共享等，需要我们调研人员与各个模块或科室的相关负责人进行多方沟通，确定一个多方满意的需求调研结果。 2.3注意事项 ●调研过程中，用户说的很快，不可能等我们全部记录之后， 再讲下一个问题。因此，只能在笔记本上速记，有时只能记录1、2个关键字。因此，每天调研结束之后，当天晚上必须整理当天的调研情况，写成一份调研日记。整理当天的调研记录时，还要整理出待明确的问题，下一次再找机会与用户再沟通、确认。
●调研的各个阶段，必须出具相关文档或文件，比如调研计划、 流程图、表单样式、报表格式、背景图片、数据项列表、讨论记录、问题列表等。 ●所有疑问必须等到明确的答复，不能出现相互矛盾、似是而 非的需求。需准确理解客户的讲解，如果有问题的先做记录，之后将整理的问题向客户询问，得到明确的结果。需求必须是客户接受和确认的，不能有臆测的需求。 ●要合理安排好时间和进度。有时候客户还有自己要做的事情， 不一定能及时相应。所以必须提前预约好时间，保证整个需求调研的进度。 ●能积极引导客户。当客户出现疑虑，而调研人员能明白且能 做好客户想要的东西的时候，调研人员能及时积极引导客户，详细讲解我们所知道的东西，并能让客户接受与确认。 ●如遇公司有相关原型或产品，调研人员需先详细了解公司的 相关原型和产品，根据成品，找出本地化的差异化需求。 3可行性分析 这个阶段要回答的关键问题：“对于上一个阶段所确定的问题有行得通的解决办法吗？”为了回答这个问题，系统分析员需要进行一次大大压缩和简化了的系统分析和设计的过程，也就是在较抽象的高层次上进行的分析和设计的过程。 可行性研究应该比较简短，这个阶段的任务不是具体解决
1.1需求规格说明书 需求规格相当于软件开发的图纸，一般说，软件需求规格说明书的格式可以根 据项目的具体情况采用不同的格式，没有统一的标准。下面是一个可以参照的 软件需求规格说明书的模板。 1．导言 1.1目的 [说明编写这份项目需求规格的目的，指出预期的读者] 1.2背景 说明： a）待开发的产品名称； b）本项目的任务提出者、开发者、用户及实现该产品的单位； c）该系统同其他系统的相互来往关系。 1.3缩写说明 [缩写] [缩写说明] 列出本文件中用到的外文首字母组词的原词组。 1.4术语定义 [术语] [术语定义] 列出本文件中用到的专门术语的定义。 1.5参考资料 [编号]《参考资料》[版本号] 列出相关的参考资料。 1.6版本更新信息 具体版本更新记录如表所列。 表版本更新记录 2．任务概述 2.1 系统定义 本节描述内容包括： ●项目来源及背景； ●项目要达到的目标，如市场目标、技术目标等； ●系统整体结构，如系统框架、系统提供的主要功能，涉及的接口等； ●各组成部分结构，如果所定义的产品是一个更大的系统的一个组成部分， 则应说明本产品与该系统中其他各组成部分之间的关系，为此可使用一张 方框图来说明该系统的组成和本产品同其他各部分的联系和接口。 2.2 应用环境 本节应根据用户的要求对系统的运行环境进行定义，描述内容包括： ●设备环境； ●系统运行硬件环境；
●系统运行软件环境； ●系统运行网络环境； ●用户操作模式； ●当前应用环境。 2.3 假定和约束 列出进行本产品开发工作的假定和约束，例如经费限制、开发期限等。列出本产品的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长以及本产品的预期使用频度等重要约束。 3．需求规定 1.1对功能的规定 本节依据合同中定义的系统组成部分分别描述其功能，描述应包括： ●功能编号； ●所属产品编号； ●优先级； ●功能定义； ●功能描述。 1.2对性能的规定 本节描述用户对系统的性能需求，可能的系统性能需求有： ●系统响应时间需求； ●系统开放性需求； ●系统可靠性需求； ●系统可移植性和可扩展性需求； ●系统安全性需求； ●现有资源利用性需求。 1.2.1精度 说明对该产品的输入、输出数据精度的要求，可能包括传输过程中的精度。 1.2.2时间特性要求 说明对于该产品的时间特性要求，如对： a）响应时间； b）更新处理时间； c）数据的转换和传送时间； d）计算时间等的要求。 1.2.3灵活性 说明对该产品的灵活性的要求，即当需求发生某些变化时，该产品对这些变化的适应能力，如： a）操作方式上的变化； b）运行环境的变化； c）同其他系统的接口的变化； d）精度和有效时限的变化； e）计划的变化或改进。 对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。 1.3输入输出的要求 解释各输入输出的数据类型，并逐项说明其媒体、格式、数值范围、精度等。 对软件的数据输出及必须标明的控制输出量进行解释并举例，包括对硬拷贝报
软件开发技术文档编写规范 在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。 ◇可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。 ◇项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 ◇软件需求说明书（软件规格说明书）：对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。 ◇概要设计说明书：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。 ◇详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 ◇用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。 ◇测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 ◇测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。 ◇开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 ◇项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。 ◇软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。 ◇软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。 ◇软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。 1可行性分析报告 1 引言 1.1 编写目的：阐明编写可行性研究报告的目的，提出读者对象。
软件文档编写指南 封面格式： 文档编号 版本号 文档名称： 项目名称： 项目负责人： 编写年月日 校对年月日 审核年月日 批准年月日 开发单位 系统规约说明书（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）对现有软件的影响
文档编号：_________ _________ 文档名称：____________ 项目名称：____________ 项目负责人：____________ 编写：___________ ____年__月__日
校对：___________ ____年__月__日审核：___________ ____年__月__日批准：___________ ____年__月__日 开发单位：广东传讯网络信息有限公司________________________ 系统规格说明
一、系统功能和目标： 随着因特网的不断普及，国内的用户数呈指数级增长。作为因特网最为常用的电子邮件系统越来越受到人们的喜爱，为了满足不断增长的信息交换的需要，各行各业都希望有自己的邮件系统。广东传讯网络信息有限公司自主设计开发了适合中国国情的免费电子邮件系统，用以解决这一日益突出的问题。CHINATION免费电子邮件系统是专为免费电子邮件服务商、企业集团设计的电子邮件系统。 Chination免费电子邮件系统的设计目标是立足于一个高度集成的、功能强大、技术先进的电子邮件系统。高度集成意味着本系统将把硬盘软件集成在一起。系统是基于LINUX下的，硬盘和软件的集成使得系统具有绝对的安装优势。功能强大意味着系统的实用性，功能的全面性，系统的安全性和可靠性。技术先进意味着将最新版本的LDAP，IMAP，POSTFIX，MYSQL，APACHE 和PHP的巧妙结合。 本系统要实现的主要功能有： 1．用户申请注册功能。用户通过申请可以得到一个自己命名的信箱，容量大小为10M。 2．用户忘记密码处理功能。用户忘记密码可以通过注册时设置的密码提示问题来重设密码。 3．用户收邮件功能。它包括SMTP收邮件、POP3取邮件和WWW读邮件三种方式。 4．用户发邮件功能。它包括SMTP发邮件、WWW直接发送邮件、暗送邮件、抄送邮件、定时发送邮件。 5．用户信件处理功能。系统初始设置4个文件夹来分类处理信件：收件箱、发件箱、草稿箱和垃圾箱。用户还可以自己建立新的文件夹。信件在各个信箱之间可以相互移动。 6．用户查找功能。用户可以使用查找功能通过查找信件主题或信件内容来找到自己需要的信件。 7．用户信箱配置设置。它包括个人资料更改、密码更改、参数设置、POP3服务器设置、过滤器设置、自动转信、定时发信、签名设置。 8．管理员管理用户和信箱邮件功能。包括输入（增删改）、查询、统计、报表。系统性能参数设置。 9．广播功能。它用于公司定期向一定的用户发送信息，由于一般的用户数有一定数量，所以必须用数据库管。 二、可行性分析 1．技术可行性 本软件拟决定最终在分布式系统上来运行。硬件方面，由于广东传讯网络信息有限公司是国外多
GB8567－88软件开发主要文档编写规范
GB8567－88软件开发主要文档编写规范
233 GB 8567－88软件开发主要文档编写规范 本附录中列出了《计算机软件产品开发文件 编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。 一、 可行性研究报告 l 引言 1.1 编写目的 说明：说明本可行性研究报告的编写目的，指出预期的读者。 1.2 背景 说明： a ．所建议开发的软件系统的名称。 b ．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。 c ．该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 定义 列出本文件中用到的专门术语的定义和 外文首字母组词的原词组。
234 1.4 参考资料 列出用得着的参考资料，如： a ．本项目的经核准的计划任务书或合同、上级机关的批文。 b ．属干本项目的其他已发表的文件。 c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表 日期和出版单位，说明能够得到这些文件资料的来源。 2 可行性研究的前提 说明对建议开发项目进行可行性研究的前 提，如要求、目标、条件、假定和限制等。 2.1 要求 说明对所建议开发软件的基本要求，如： a ．功能。 b ．性能。 c ．输出如报告、文件或数据，对每项输 出要说明其特征，如用途、产生频度、接口以及分发对象。 d. 输入说明。系统的输入包括数据 的来源、类型、数量、数据的组织以及提供的频
软件开发过程规范 第一部分软件需求分析规范 1、引言 本标准规定了软件需求分析阶段的任务、过程和相关要求，以及需求分析阶段的完成标志。它是软件开发规范的组成部分。 本标准适用于软件需求分析阶段的所有任务和相关人员，包括项目管理人员、软件需求分析人员、文档编制人员和质量审核人员。 2、参考文献 2.1GB8566-88 计算机软件开发规范 2.2ISO/IEC 12207:1995 信息技术——软件生存周期过程 2.3GXB 02-001 软件开发规范：第一部分软件生存周期 2.4GXB 01-001 软件工程术语 2.5GXB 02-007 软件测试规范 3、术语 本标准的术语的定义与GXB 01-001软件工程术语中的定义相一致。 4、需求分析的任务和过程 4.1需求分析任务 确定被开发软件的运行环境、功能、性能和数据需求，建立确认测试准则，编写用户手册，为概要设计提供需求说明书。 4.2需求分析过程 需求分析过程由下列步骤组成： 1）确定需求分析方法和工具； 2）人员培训； 3）确定需求分析输入；
4）需求分析； 5）制定确定测试计划； 6）修改开发计划； 7）编制文档； 8）需求分析审查； 9）需求分析文档存档。 5、总体要求 5.1用户参与 软件需求分析应该有客户指定的人员参加。 5.2用户确认 需求说明必须明确，经过客户同意，并用合同的方式予以确认。 5.3面向用户描述需求 应以用户能够理解的形式和术语描述需求，以利于与用户沟通。 6、需求分析流程 6.1确定需求分析方法和工具 选定合适的需求分析方法，在一个软件项目内所用的分析方法应该保持一致性。候选分析方法： 1）结构分析方法，包括面向数据流的分析方法和面向数据结构的分析方法。 2）面向对象的分析方法。 在需求分析方法选定后，应确定支持该方法的工具。在一个软件项目内，需求建模语言和工具应该保持一致性和规范化。 6.2人员培训 针对所选定的设计方法和工具，以及相关的标准对需求人员进行相应的培训。这是一个可选项，但对于新的方法和工具，或新的分析人员，培训是必需的。
神州数码（中国）有限公司 秘级：内部保密文件仅限内部使用 概要设计说明书模板 （V1.2） 文档编号：DC-QG-23-01 文档名称：概要设计说明书编写：沙存孝编写日期：1999.7.16 审核：钱增祺审核日期：1999.7.16 神州数码（中国）有限公司
用户名称 神州数码（中国）有限公司 秘级： 项目名称 概要设计说明书 （版本号） 文档编号：项目名称： 编写：编写日期： 审核：审核日期： 神州数码（中国）有限公司[项目名称]项目组
文档修订记录
目录 第一章引言 (6) 第一节编写目的 (6) 1.1.1作用 (6) 1.1.2预期读者 (6) 第二节编写背景 (7) 1.2.1 系统名称及版本号 (7) 1.2.2 任务提出者 (7) 1.2.3 任务承接者及实施者 (7) 1.2.4 使用者 (7) 1.2.5 与其它系统的关系 (7) 第三节文档结构 (7) 第四节电子文档编写工具 (7) 第五节定义说明与符号规定 (8) 第六节参考资料 (9) 第二章系统概述 (9) 第一节系统目标 (9) 第二节设计原则 (9) 第三节运行环境 (9) 2.3.1 硬件平台 (9) 2.3.2 软件平台 (9) 2.3.3 网络体系结构 (10) 第四节应用软件整体结构概述 (10) 第五节关键技术 (10) 第三章数据库设计 (11) 第一节数据组织 (11) 3.1.1数据分布方式 (11) 3.1.2数据传输与通讯 (11) 3.1.3 历史数据管理 (11) 第二节实体集列表 (11) 第三节概念数据模型图 (12) 第四节数据量估计 (14) 第五节数据分布方案 (14) 第六节实体与基本表的对应关系 (14) 第七节物理数据模型图 (15) 第八节数据库系统介绍 (15) 第四章代码设计 (16) 第一节背景介绍 (16) 第二节编制说明 (16) 第三节代码表列表 (17)
软件开发过程规范范文 1. 前言 1.1 目的 本规范的目的是使整个软件产品开发及项目工程阶段清晰，要求明确，任务具体，便于规范化、系统化及工程化。有利于提高软件生命周期的控制及管理，提高所开发软件的质量，缩短开发时间，减少开发和维护费用，使软件开发活动更科学、更有成效。 1.2 对象 本规范面向产品生命周期的所有相关人员，包括管理人员、开发人员、质管人员。 1.3 要求 具有软件开发管理职能的人员要求熟知项目开发的各阶段过程和各阶段过程相应的规范。 1.4 适用范围 适用于产品开发生命周期中的除产品提交外的其他全部过程；规范分为两部分：技术过程规范和管理过程规范，分别适用于软件开发过程中的技术性活动和管理性活动。 1.5 软件开发过程模型 本规范所采用的软件开发过程模型为简化的RUP开发过程模型；软件开发过程是体系结构为中心，用例驱动和风险驱动相结合的过程迭代。 1.6 开发过程划分 开发过程包括多次迭代，每次迭代的目标和侧重点不同；较早的迭代侧重于业务建模和需求建模；而后的迭代则侧重于分析设计和编码。 2. 技术过程规范部分 2.1 概述 本规范中将软件开发的整个技术过程分为四个顺序实施的阶段，分别为业务建模阶段、需求阶段、分析设计阶段和实现阶段。在对技术过程规范的描述，按阶段内部的活动和产物对四个阶段分别说明。 在本规范中对阶段内活动的说明，是按顺序性活动和持续性活动两类分别进行说明。
对于顺序性活动是按该阶段中活动的总体顺序进行的描述，而在实际工作中，从各活动的具体实施的细节来看，各活动之间的顺序是不断交叉变化的。对于持续性活动主要是对贯穿该阶段过程始终的技术活动进行说明。 规范中所提到的可选文档是指在其所属阶段，可根据具体情况灵活掌握，开发团队自主决定是否开发的文档产物。而提交文档则是指在项目开发过程中必须开发的文档产物，但可根据具体项目情况，在软件开发计划中明确规定是否要形成正式文档并提交。 规范中各阶段提到的技术评审，具体参见《评审规范》中所对应技术性评审的详细描述。 2.2 业务建模阶段 2.2.1 顺序性活动描述 1)开始初步调研，获取初始业务需求，进行问题定义，形成《业 务概览》并建立《术语表》； 2)制定《调研记录表册》，实施详细的业务调研，建立初始的 业务用例模型和《业务用例规格》； 3)分析业务过程，取出可以实现自动化的用例，分析业务部门 和实体对象，形成初始的业务对象模型； 4)根据初始业务对象模型和初始业务用例模型，分析并提取与 系统实现相关的用例和模型，建立系统域模型； 5)精化域模型中的初始用例，详细描述业务流程，分析业务规 则，建立精化的业务用例模型，形成《业务规则》和《业务 用例规格》； 6)精化域模型中的初始对象，进行详细的对象描述，分析对象 职责和对象间关系，建立精化的业务对象模型，形成《业务 对象纵览》； 7)分析业务上的非功能性需求，形成《增补业务规格》； 8)应用业务对象，实现业务用例，制定《业务用例实现规格》， 以验证业务对象与业务用例的正确性，根据验证结果，修正 业务对象、业务用例及相关文档； 9)汇总《业务规则》《业务用例规格》《业务对象纵览》《增 补业务规格》和《业务用例实现规格》形成《业务架构文档》。 2.2.2 持续性活动描述 1)《业务概览》在业务建模阶段，根据对项目理解的不断加深， 随时进行改进； 2)《术语表》的更新维护； 2.2.3 提交文档 1)《业务概览》 2)《术语表》 3)《调研记录表册》 4)《业务架构文档》其附件包括：《业务规则》《业务用例规