软件开发和文档编制程序
本标准规定了软件产品开发研制过程质量职责及控制要求。
本标准适用于本公司研制的计算机各类型软件的管理。
2 引用标准
GB8567—88 计算机软件产品开发文件编制指南
3 定义
不需用。
4 职责
设计部门负责人批准软件开发项目任务书。
技术发展部负责组织对公司下达的软件项目进行各阶段的评审。物流部经理负责组织项目的最终检测。
项目负责人负责组织对软件项目的各阶段进行考核、质量控制、组织接口协调文档的发布批准及文档更改审批。
项目负责人(软件负责人)负责：
a、制定软件课题开发计划和进度安排及资源需求；
b、进行总体设计；
c、提供阶段评审资料；
d、协调技术接口。
标准档案室管理员负责文档的存贮、保管和处理。
5 工作程序与要求
公司下达的软件项目立项后，由技术发展部下达[新产品研制任务书]。
软件项目
5.2.1 公司立项项目由技术发展部负责组织评审。
a、项目负责人（软件负责人）于评审前3天填写[评审申请表]，
并备齐评审资料，交技术发展部。
b、技术发展部审批评审申请表，并将有关资料提前3-5天下发
评审组成员以供分工审阅，
c、评审组长主持评审会，并填写[评审报告]；评审结束，技术
发展部负责收回评审资料交项目组存档。
5.2.2 凡上级下达的项目，若上级部门（或系统组织单位）对评审另
有要求时，则按其执行；否则，按条执行。
5.2.4 若项目既有软件开发，又有硬件开发，其评审是分开（软件、
硬件）还是合并进行，由设计部门负责人决定。
软件项目的检测
5. 3. 1 项目负责人负责组织完成下述工作。
a、测试阶段的检测；
b、软件课题的系统检测；
c、软件版本存档前的检测。
对以上测试发现的问题，由项目组填写[软件测试修改单]，经分析原因和采取纠正措施及回归测试后，由项目负责人审批，方可列入正式版本。
5. 3. 2 物流部经理负责组织软件版本存档前的最终检测，并在[版
本送检（启用）通知单]上签署检测结果。
5. 4 设计部门负责人批准软件项目开发计划。
设计部门负责人审批各项目负责人资格，并负责：
a、考核各阶段的进度完成情况；
b、及时协调开发中组织接口及计划修改；
c、控制项目开发各阶段的设计输入、设计输出、技术状态和各阶段的验
证,并对软件的正确性、文档的完整性负责。
项目负责人(软件负责人)负责组织：
a、制定项目开发计划，若软件、硬件相结合的，其计划也可合
并制定。开发计划须明确划分各开发阶段，并可按开发阶段进
行自主开发；
b、总体设计；
c、提供各阶段文档(包括评审文档)，并于鉴定后一周内存入标准档案室；
d、组织软件(版本)检测，并对检测结果负责；
e、协调技术接口；
f、定期填报工作进度，若进度计划需修改，应在报表中申述（进
度报表既可按月也可按项目分阶段填报）。
软件的交付管理
按[版本启用/存档细则]执行。
软件版本管理
5.8.1 应顾客需要进行软件版本升级或修订时，设计部门负责人确定
项目负责人，组织软件人员实施。
5.8.2 软件负责人发出[版本送检（启用）通知单]升级的版本由物
流部组织检测合格后，由软件负责人将新版本存入标准档案室；
并在[版本档案]中详细记录升级内容，存入项目档案中。
5.8.3 技术人员在为顾客服务的现场，遇到需要版本修订时，应先
电告项目负责人，经认可后，回厂填写[用户服务档案]，必要时项目负责人应组织评审和检测。
文档要求
5.9.1 各阶段需具备的基本文档及文档格式（见附录）
鉴定需具备的文档参见附录。
6 支持文件
7 记录
质量记录
7.1.1 JL/ 版本启用通知单
7.1.2 JL/ 用户服务档案
7.1.3 JL/ 软件测试修改单
以上记录由标准档案室保存三年。
工作记录
7.2.3 版本档案
以上记录由标准档案室保存三年。
附录
附录一：软件产品文件表
附录二：版本启用/存档实施细则
附录三：概要设计说明书
附录四：需求说明书
附录五：软件开发规范
附录六：程序设计若干规定
附录一：
软件产品文件表
注：●表示必须编制的文件；○表示可根据产品的需要制定。
湖南计算机股份有限公司
用户服务档案
JL/
湖南计算机股份有限公司
版本档案
（工作记录）
编号：
软件测试修改单
JL/
附录二：
版本启用/存档实施细则
为了规范版本的管理，减少版本的数量，
文档资料的管理和保存，文档的及时更新，以及便于电子化的管理和规范工作流程，特制定该实施细则。
一、工作流程和任务
:
说明：
1. 内部测试：
进行白盒测试，要求对源程序进行检查，分析出可能影响的模块，并对相应的模块进行测试。
2.外部测试：
进行黑盒测试，对整个系统进行测试。
3.审核：
检查文件的完整性和正确性。
4.资料审查：
检查文件的完整性和格式的正确性。
5.批准：
审查该版本是否可以发行。委派他人对提交的文档进行抽查，验证其正确性和完备性。
6.编号、录入数据、刻盘：
光盘的卷标为8位数字的序列号，在根目录下建立以版本编号为名称的子目录，所有提交的文档资料存放在该子目录中。
版本启用通知单
概要设计说明书
概述
介绍该项目的名称、任务提出者、提出的背景，应用的目标。
功能和性能
对照软件需求说明书，来说明系统是如何满足功能和性能需求的。
开发工具和平台
描述采用何种操作系统平台、何种编程语言、开发工具进行开发。
总体结构设计
用图表和文字方式说明该系统由几个模块构成，各模块的功能、各模块之间的关系。
用数据流图描述出数据在该系统中的流动过程，在各模块输入前和输出后数据的变换。
用程序流程图描述出主要功能的实现方式。
接口设计
外部接口
说明该系统同外部所有的接口安排，包括硬件接口、软件接口、用户接口。
内部接口
说明该系统内部各个模块之间的接口安排。
系统数据结构设计
逻辑数据结构设计
给出该系统内所使用的每个数据项、记录、文件的标识、定义、长度以及他们之间
的相互关系。
物理数据结构设计
给出系统中的数据的存储要求和访问方式、和存储介质。
系统出错处理设计
出错信息
用表格形式列出每种可能的出错或故障情况出现时，系统输出信息的形式、含义及
处理方法。
补救措施
说明故障出现后可能采取的变通措施，如后备技术、降效技术、恢复及再启动技术
等。
系统维护设计
说明为了系统维护方便而在程序内部设计中作出的安排，如在程序中专门安排用于系统的检查与维护的检测点和专用模块。
关键的技术和难点
描述开发该系统采用的关键技术和难点，对关键技术和难点作出风险评估，要求作出相应的解决对策，或提出其他的解决方案。
交付方式
交付的内容
全部的设计文件、发行版本、源程序
交付的媒体介质
纸质文件、电子文件、CD、FLASH、软盘
附录四：
需求说明书
简介
介绍该项目的名称、任务提出者、提出的背景，应用的目标
详细需求
环境需求
硬件环境
描述运行该软件需要的设备能力
处理器的速度、数量和内存容量
存储媒体的容量
输入、输出设备的种类和数量
通讯网络
软件环境
运行该软件需要的操作系统、数据库软件、以及相应的其他应用软件人员环境
操作该软件对人员的要求，人员的素质、数量
功能需求
对系统中每一个功能，要求用图示或文字详细描述：
概述——叙述功能名称、目标和作用
输入——详述该功能输入的信息
处理——描述该功能作什么，如何对输入信息进行加工并转换成输出信息
输出——详述该功能输出的信息
内部生成数据——列出用户所关心的内部生成数据
性能需求
定量的描述该软件系统应满足的具体性能需求
精度
说明该软件系统的精度要求，如：
数据的精度要求
数字计算的精度要求
数据转送的误码率要求
时间特性
说明该软件系统的时间要求，如：
解题时间
询问和更新数据文件的响应时间
系统各项功能的顺序关系
由于输入类型的不同和操作方式的变化而引起的优先顺序
在峰值负载期，与所规定的响应时间的允许偏离范围
灵活性
说明当需求发生某些变化时该软件系统的适应能力，指出为适应这些变化而需
要设计的软件成分和过程
输入和输出
描述输入和输出的每个数据元素，对每个数据元素可列出如下信息：
数据元素名
同义名
定义
格式
值域
度量单位
数据项名、缩写词和代码
对于输入数据，还要说明时间要求、优先顺序和输入媒体。对于输出数据，亦要
说明时间要求、优先顺序和输出形式，并要描述对特殊输入输出项的保密要求和
措施。
数据库特性
详细描述数据库中要用到的每个数据元素，对每个数据元素可列出如下信息：数据元素名
同义名
定义
格式
值域
度量单位
数据项名、缩写词和代码
要根据记录的规模和数量来估计数据存储要求，并要预测数据的增长率。
故障处理
列出在该系统出现故障时，为满足信息处理要求而可能采取的技术措施，如：后备技术
低效技术
再启动技术
接口
说明该软件系统与其他系统和子系统的接口
软件接口和硬件接口
安全和保密
说明该软件系统在安全和保密方面的要求
交付方式
交付的内容
全部的设计文件、发行版本、源程序
交付的媒体介质
纸质文件、电子文件、CD、FLASH、软盘
附录五：
软件开发规范
软件开发的流程和需要的文档资料同项目开发类似，在第章中有详细的描述，在这不再作介绍了，仅介绍与软件紧密相关的常用文档资料的格式模板，以及编程设计中的若干规定
常用文档的格式模板
流程图
概述
国家标准GB1526-89《信息处理—数据流程图、程序流程图、系统流程图、程序网络图和系统资源图的文件编制符号及约定》规定了信息处理文件使用的各种符
号及其使用的具体约定。
要求采用VISIO或SMARTDRAW软件绘制流程图。
流程图所用符号及其简要说明
使用约定
图的布局
流程图所用的符号应该均匀分布，连线保持合理的长度，并尽量少使用长线。
符号标志符
这是赋予某个符号的标志符，其作用是便于其他文件中引用该符号。符号标志符要写在符号的左上角。
符号描述符
它用于交叉引用，表达一个符号的特殊用途，或者进一步理解某个符号的功能。
描述符要写在符号的右上角。
(国内标准)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. 控制精度或生产能力的提高。
软件开发流程
快视信息软件开发流程规范： 用户需求：软件项目首先由客户经理(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
软件开发文档范例
文档编号：_________ _________ 文档名称：____________ 项目名称：____________ 项目负责人：____________ 编写：___________ ____年__月__日 校对：___________ ____年__月__日 审核：___________ ____年__月__日 批准：___________ ____年__月__日
开发单位：传讯网络信息 ________________________ 系统规格说明 一、系统功能和目标： 随着因特网的不断普及，国的用户数呈指数级增长。作为因特网最为常用的电子系统越来越受到人们的喜爱，为了满足不断增长的信息交换的需要，各行各业都希望有自己的系统。传讯网络信息自主设计开发了适合中国国情的免费电子系统，用以解决这一日益突出的问题。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．技术可行性 本软件拟决定最终在分布式系统上来运行。硬件方面，由于传讯网络信息是国外多家公司并行处理产品的代理商，而且自己本身拥有ALPHA机等先进设备，所以有足够能力开发出先进的电子系统。软件方面，我们拟采用以下几种软件： 1）操作系统用LINUX。Linux作为一个优秀的网络操作系统，它的发行版本中集成了大量的网络应用软件，如Web服务器(apache)、Ftp服务器(wu-ftp)、服务器(sendmail+imap4)、SQL数据库(postgresql)等，可以快速的构建Intranet环境，并且也有精致的收发程序(metamail)和强大的Web 服务器端开发工具(PHP4)。当你配置好sendmail并激活imapd后，你的Linux用户都可以使用Outlook等客户端软件进行收发，只要通过将它们集中进行应用，便可以实现一个简单的Webmail 服务器的功能。但是随着自由软件的不断开发，要构架一个好的电子系统，就面临着软件选择是否适当、性能是否比别人好的问题。下面列出我们所使用的软件。 2）本系统壳软件用imap。有几种方法可以构造电子系统的壳：共享文件系统的策略，基于局域网的专用协议，X.400P7协议和因特网消息存取协议。而基于INTERNET的协议主要有：POP (Post Office Protocol), DMSP (Distributed Mail System Protocol), 和IMAP (Internet Message Access Protocol).POP是最原始，最为人们所知的一种。DMSP仅局限于一个简单应用——PCMAIL，它的优点主要在于对脱机状态操作的支持。IMAP不但继承了POP和DMSP的优点，而且超越了他们的缺点，提供了三种状态下对远程信箱的访问：在线、不连接和脱机状态。在脱机状态，可以发送到一个共享的服务器，但是客户并不是马上全部把它们COPY过去之后在服务器上删掉它们，
软件开发文档规范
附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 ）详细设计说明
软件开发文档说明书(完整流程)
. 在软件行业有一句话：一个软件能否顺利的完成并且功能是否完善，重要是看这个软件有多少文档，软件开发文档是一个软件的支柱，如果你的开发文档漏洞百出，那么你所开发出来的软件也不可能会好；开发文档的好坏可以直接影响到所开发出来软件的成功与否。 一、软件开发设计文档：软件开发文档包括软件需求说明书、数据要求说有书、概要设计说明书、详细设计说明书。 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 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。可行性研究报告的编写内容要求如下： 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 关键问题 2.4 支持条件 2.4.1 计算机系统支持 2.4.2 需要用户承担的工作 2.4.3 需由外单位提供的条件 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．服务（阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。）
一个完整的软件开发流程
一个完整的软件开发流程 一、开发流程图 二、过程产物及要求 本表主要列出开发阶段需要输出的过程产物，包括产物名称、成果描述、负责人及备注，即谁、在什么时间、应该提供什么内容、提供内容的基本方向和形式是什么。 三、过程说明 (一)项目启动 1、产品经理和项目干系人确定项目方向，产品型项目的干系人包括公司领导、产品总监、技术总监等，项目的话则包括客户方领导、主要执行人等。
2、公司领导确认项目组团队组成，包括产品经理、研发项目经理、研发工程师、测试团队等。 3、明确项目管理制度，每个阶段的成果产物需要进行相应的评审，评审有相应的《会议纪要》;从项目启动起，研发项目经理每周提供《项目研发周报》;测试阶段，测试工程师每周提供《项目测试周报》。 4、产品经理进行需求调研，输出《需求调研》文档。需求调研的方式主要有背景资料调查和访谈。 5、产品经理完成《业务梳理》。首先，明确每个项目的目标;其次，梳理项目涉及的角色;再来，每个角色要进行的事项;最后，再梳理整个系统分哪些端口，要有哪些业务模块，每个模块再包含哪些功能。 (二)需求阶段 1、进入可视化产物的输出阶段，产品经理提供最简单也最接近成品的《产品原型》，线框图形式即可。在这个过程中还可能产生的包括业务流程图和页面跳转流程图。业务流程图侧重在不同节点不同角色所进行的操作，页面跳转流程图主要指不同界面间的跳转关系。项目管理者联盟 2、产品经理面向整个团队，进行需求的讲解。 3、研发项目经理根据需求及项目要求，明确《项目里程碑》。根据项目里程表，完成《产品开发计划》，明确详细阶段的时间点，最后根据开发计划，进行《项目任务分解》，完成项目的分工。 4、研发工程师按照各自的分工，进入概要需求阶段。《概要需求》旨在让研发工程师初步理解业务，评估技术可行性。 (三)设计阶段 1、UI设计师根据产品的原型，输出《界面效果图》，并提供界面的标注，最后根据主要的界面，提供一套《UI设计规范》。UI设计规范主要是明确常用界面形式尺寸等，方便研发快速开发。UI设计常涵盖交互的内容。 2、研发工程师在界面效果图，输出《需求规格》，需求规格应包含最终要实现的内容的一切要素。 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 关键问题
软件工程文档模板范例.doc
目录 三、需求规格说明书 (2) 四、概要设计说明书 (12) 五、详细设计说明书 (15)
3软件需求说明书 软件需求说明书的编制是为了使用户的软件开发者双方对该软件的起初规定有一个共同的理解，使之成为整个开发工作的基础。编制软件需求说明书的内容要求如下： 3.1引言 3.1.1编写的目的 3.1.2背景 3.1.3定义 3.1.1参考资料 3.2任务概述 3.2.1目标 3.2.2用户的点 3.2.3假定与约束 3.3需求规定 3.3.1对功能的规定 3.3.2对性能的规定
3.3.2.1精度 3.3.2.2时间特性要求 3.3.2.3灵活性 3.3.3输入输出要求 3.3.4数据管理能力的要求 3.3.5故障处理要求 3.3.6其它的专门的要求 3.4运行环境规定 3.4.1设备 3.4.2支持软件 3.4.3接口 3.4.4控制 4数据需求说明书 数据要求说明书的编制目的是为了向整个开发时期提供关于处理数据的描述和数据采集要求的技术信息。编制数据要求说明书的内容要求如下： 4.1引言
4.1.1编写目的 4.1.2背景 4.1.3定义 4.1.4参考资料 4.2数据的逻辑描述 4.2.1静态数据 4.2.2动态输入数据 4.2.3动态输出数据 4.2.4内部生成数据 4.2.5数据约定 4.3数据的采集 4.3.1要求和范围 4.3.2输入的承担者 4.3.3处理 4.3.4影响 5概要设计说明书 概要设计说明书可称作系统设计说明书，这里说的系统是指程序系统，编制的目
的是说明对程序的系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。编制概要设计说明书的内容要求如下： 5.1引言 5.1.1编写目的 5.1.2背景 5.1.3定义 5.1.4参考资料 5.2总体设计 5.2.1需求规定 5.2.2运行环境 5.2.3基本设计概念和处理流程 5.2.4结构 5.2.5功能需求与程序的关系 5.2.6人工处理过程
软件开发文档说明(又全又详细)
在软件行业有一句话：一个软件能否顺利的完成并且功能是否完善，重要是看这个软件有多少文档，软件开发文档是一个软件的支柱，如果你的开发文档漏洞百出，那么你所开发出来的软件也不可能会好；开发文档的好坏可以直接影响到所开发出来软件的成功与否。 一、软件开发设计文档：软件开发文档包括软件需求说明书、数据要求说有书、概要设计说明书、详细设计说明书。 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 功能需求与程序的关系2． 6 人工处理过程2． 7 尚未解决的问题 3 接口设计3．1 用户接口3．2 外部接口3.。3 内部接口 4 运行设计4．1 运行模块的组合4．2 运行控制4．3 运行时间 5 系统数据结构设计5．1 逻辑结构设计要点5．2 物理结构设计要求5．3 数据结构与程序的关系 6 系统出错处理设计6．1 出错信息6．2 补救措施6．3 系统维护设计。 3.详细设计文档：主要是把我们每个小模块，小功能的业务逻辑处理用文字的方式表达出来，让程序员在编码的时
软件开发过程规范
【最新资料,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结束项目..................................................................................................................................
软件开发文档模板
1引言 编写目的 背景 定义 参考资料 2总体设计 需求规定 运行环境 基本设计概念和处理流程 结构 功能器求与程序的关系 人工处理过程 尚未问决的问题 3接口设计 用户接口 外部接口 内部接口 4运行设计 运行模块组合 运行控制 运行时间 5系统数据结构设计 逻辑结构设计要点 物理结构设计要点 数据结构与程序的关系 6系统出错处理设计
出错信息 补救措施 系统维护设计 **************************************** 2、 ISO9001标准文档模版 第1章引言 编写目的 术语 参考文献 第2章系统概述 系统说明 系统任务 2.2.1 系统目标 2.2.2 运行环境 2.2.3 与其它系统关系 需求规定 2.3.1 功能需求 2.3.2 性能需求 2.3.3 数据要求 2.3.4 其它 第3章总体设计 系统物理结构 3.1.1 系统流程图 3.1.2 设备清单 软件结构图
3.2.1 模块结构图 3.2.2 模块清单 第4章模块功能描述 模块1（标识符）功能 模块2 （标识符）功能 第5章接口设计 用户界面 硬件接口 软件接口 通信接口 第6章数据结构设计 数据结构1 （标识符） 6.1.1 结构属性 6.1.2 逻辑结构 6.1.3 物理结构 6.1.4 数据元素 数据结构2 （标识符） 第7章运行设计 运行1 7.1.1 运行模块组合运行名称 7.1.2 运行控制操作 7.1.3 运行时间 运行2 第8章系统安全 系统安全 数据安全 后备与恢复
出错处理 计算机病毒的防治措施 第9章功能需求、数据结构和模块 功能需求与模块关系 数据结构与模块关系 **************************************** 概要设计说明书 1 引言 写目的：阐明编写概要设计说明书的目的，指明读者对象。 项目背景：应包括 ●项目的委托单位、开发单位和主管部门 ●该软件系统与其他系统的关系。 定义：列出本文档中所用到的专门术语的定义和缩写词的愿意。 参考资料： ●列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源 ●项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规格说明书；测试计划（初稿）；用户操作手册 ●文档所引用的资料、采用的标准或规范。 2 任务概述 目标 需求概述 条件与限制 3 总体设计 总体结构和模块外部设计
软件开发设计文档模板
软件文档编写指南 封面格式： 文档编号 版本号 文档名称： 项目名称： 项目负责人： 编写年月日 校对年月日 审核年月日 批准年月日 开发单位 系统规约说明书（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.1开发流程总述 如下图示流程定义了我公司内部的软件开发过程，以指导和规范软件项目中开发过程的定义和相应的实施。 该过程可划分为一系列子过程，包括：软件需求分析、设计、编码、测试、验收、维护，每个子过程又由一系列任务和活动组成，如设计过程又可分为结构设计和详细设计。但是在实际开发项目中，情况仍然会是千变万化的，因此我们也并不是一成不变的死板执行一个僵化的工作流程，我们的原则是在一个规范流程的指导和约束下，根据具体工程项目的实际要求，为每一个项目评估并制定真正能够最好的满足该项目要求的开发流程。
图 1.1-1 软件开发流程总图
在应用系统软件开发项目中，我们仍将遵循这一思想，这一点将在随后的项目开发实施计划部分有具体的体现，在这里和下面的相关章节中，我们仍将围绕着这个完整的开发流程来分析说明，以此来阐明我们对项目开发的完整过程管理思想和相关实践。下面我们对这个软件开发工作流程进行简要地分解说明。 1.2 软件需求分析 （1）概述 由于应用系统与众多相关应用软件需要进行交互，因此需要先对这些应用系统进行分别梳理，充分做好需求调研工作，编写经项目单位认可并评审通过的《系统需求规格说明书》。 软件需求分析是按照项目定义的软件开发过程，根据系统分配给软件的需求（见《系统需求规格说明书》），进行软件质量特性规格说明的过程。该过程包括进一步明确软件运行环境，明确对软件的功能、性能和数据要求，以及软件与硬件、软件与软件之间的接口要求等，并对软件需求进行验证和文档化，即完成对软件需求的分析与规格定义。 本元素在整个过程中的位置如下图所示： 图示：软件需求分析在软件开发过程中的位置 （2）入口准则和出口准则 软件需求分析 结构设计 系统分配给软 件的需求