【文件编写】某公司文档编写规范(WORD19页)
DOC.NO. Tech-Spec-Docu
普通
XXX部 文档编写规范
Version. 1.0
XXXX
2002-9-21
XXXXX公司
Tel: (0592)XXXXXXX
Fax: (0592) XXXXXXX
Email: X XXX@https://www.wendangku.net/doc/ca11472680.html,
https://www.wendangku.net/doc/ca11472680.html,
COMPANY CONFIDENTIAL AND PROPRIETRAY ?2001-2005 XXXXX All rights Reserved
文档编写规范
文档信息
分发名单
*行动类别: 批准, 复审, 通知, 存档, 所需行动, 参加会议,其它(请指明) 版本记录
目录
1 规范说明 (5)
1.1 目的 (5)
1.2 适用范围 (5)
1.3 名词解释 (5)
1.4 正文内容 (5)
1.5 解释权限 (5)
1.6 施行日期 (5)
2 文档统一格式定义 (6)
2.1 文档页面设置 (6)
2.2 封面格式 (6)
2.3 文档版本说明格式 (7)
2.4 页眉与页尾格式 (7)
2.5 目录格式 (7)
2.6 正文格式 (7)
3 文档编写规范 (8)
3.1 需求说明书 (8)
3.1.1 引言 (8)
3.1.2 业务流程整体说明（使用业务语言） (8)
3.1.3 特殊说明 (8)
3.1.4 原始资料 (8)
3.2 需求分析报告 (9)
3.2.1 引言 (9)
3.2.2 任务概述 (9)
3.2.3 数据描述 (9)
3.2.4 功能需求 (10)
3.2.5 性能需求 (10)
3.2.6 运行环境描述 (10)
3.2.7 其他需求 (11)
3.3 概要设计书 (11)
3.3.1 引言 (11)
3.3.2 总体设计 (11)
3.3.3 接口设计 (11)
3.3.4 数据结构设计 (12)
3.3.5 出错处理设计 (12)
3.3.6 安全保密设计 (12)
3.4 详细设计书 (12)
3.4.1 引言 (12)
3.4.2 总体设计 (13)
3.4.3 程序描述 (13)
3.5 测试计划 (13)
3.5.1 引言 (13)
3.5.2 计划 (14)
3.5.3 测试项目说明 (14)
3.5.4 评价 (14)
3.6 测试报告 (14)
3.6.1 引言 (14)
3.6.2 测试计划执行情况 (15)
3.6.3 评价 (15)
3.7 模块开发文档 (15)
3.7.1 功能说明 (15)
3.7.2 设计说明 (15)
3.7.3 源代码清单 (16)
3.7.4 测试说明 (16)
3.7.5 复审结论 (16)
3.8 用户手册 (16)
3.8.1 引言 (16)
3.8.2 系统功能介绍 (16)
3.8.3 运行环境说明 (16)
3.8.4 运行前的准备 (17)
3.8.5 输入输出说明和操作说明 (17)
3.8.6 安全与保密 (17)
3.8.7 常见问题的处理 (17)
3.8.8 附录：安装与初始化 (17)
3.9 试运行计划 (18)
3.9.1 引言 (18)
3.9.2 开发背景介绍 (18)
3.9.3 运行环境介绍 (18)
3.9.4 软件流程及模块功能说明 (18)
3.9.5 试运行所需资料 (18)
3.9.6 特殊业务的处理方法说明 (19)
3.9.7 试运行所需的业务基础数据 (19)
3.9.8 试运行进度安排 (19)
3.10 验收报告 (19)
3.10.1 引言 (19)
3.10.2 验收内容 (19)
3.10.3 软件验收结论 (19)
1规范说明
1.1 目的
为了本公司信息系统建设过程逐步规范化，实现信息系统的软件工程化实施，结合本公司的具体情况特编制《文档编制规范》。以便将来作为本公司信息系统建设软件工程化基础的一部分。
1.2 适用范围
本规范适用于XXXX。
1.3 名词解释
无
1.4 正文内容
在《文档编写规范》中定义了在项目开发和产品开发过程中必须生成的主要文档以及文档的格式与内容，这些文档包括：需求说明书、需求分析报告、概要设计书、详细设计书、测试计划、测试报告、用户手册、模块开发文档、试运行计划、验收报告。
1.5 解释权限
本规范由技术管理部负责解释。
1.6 施行日期
本规范自颁布之日起施行。
2文档统一格式定义2.1 文档页面设置
2.2 封面格式
见封面
2.3 文档版本说明格式
2.4 页眉与页脚格式
2.5 目录格式
各索引条目必须是正文的超链接：鼠标单击索引条目后进入正文。
2.6 正文格式
3文档编写规范
3.1 需求说明书
3.1.1引言
?编写目的（阐明编写需求说明书的目的）
?项目背景（应包括：a.项目的委托单位、开发单位和主管部门；b.该软件系统与其他系统的关系。）
?名词解释（列出文档中所用到的专门术语的定义和缩写词的原文。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.立项报告；b.项目开发计划；c.文档所引用的资料、标准和规范。）
3.1.2业务流程整体说明（使用业务语言）
业务人员首先应对业务有一个总体流程图，同时辅以文字说明。如果总的流程图的各个组成部分还可以细分的话，应继续用子流程图的形式对它的各组成部分进行说明并辅以文字说明，直到流程图的各个组成部分的业务步骤不可再分为止。例如代理录入订单，在详细描述中应包括以下内容：订单的详细信息；代理编号（长度要求，需要代理手工选择）；订单号（长度要求、需要代理手工输入）……………。
3.1.3特殊说明
需要特殊说明的一些问题，例如本系统与现有其他软件系统的关系等。
3.1.4原始资料
?资料收集：应收集所有与业务需求相关的原始资料，为后续工作（如：需求分析等）
做准备。
?原有业务流程概述：对原有业务流程进行说明（采取流程图方式）
?原始单据、原始报表等：以列表的方式列出原始资料的名称，而且要与原有业务流程概述的内容相对照，并将实际的原始资料附在业务分析书的后面。
3.2 需求分析报告
3.2.1引言
?编写目的（阐明编写需求分析报告的目的）
?项目背景（应包括：a.项目的委托单位、开发单位和主管部门；b.该软件系统与其他系统的关系。）
?名词解释（列出文档中所用到的专门术语的定义和缩写词的原文。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.立项报告；b.项目开发计划；c.文档所引用的资料、标准和规范。）
3.2.2任务概述
?目标
叙述该项软件开发的意图、应用目标、作用范围以及该软件的背景资料。解释被开
发软件与其他有关软件之间的关系。如果本软件是一个独立的软件，而且全部内容
自含，则说明这一点。如果定义的产品是一个更大系统的一个组成部分，则应说明
本产品与该系统中其他各组成部分之间的关系。
?假定与约束
列出本软件开发工作的假定与约束，例如经费限制、开发期限等等。
3.2.3数据描述
数据分为静态数据和动态数据。所谓静态数据，指在运行过程中主要作为参考的数据，它们在很长一段时间内不会变化，一般也不会随着运行而改变，所谓动态数据，包括所有在运行中要发生变化的数据，以及在运行中要输入、输出的数据。
?静态数据（系统运行前已有的数据）
列出所有作为控制或参考用的静态数据，并给出名称。
?动态数据（系统运行过程中需要的输入数据以及系统运行过程中产生的输出数据）列出所有动态数据，并给出名称。
?流程图
画出系统的整体流程图。
?功能划分
对于流程图中的各个功能用树状结构自顶向下进行细化。并对最底层的功能进行编
码，给出功能标识符。
?功能描述
?数据与功能的对应关系
用一张矩阵图说明功能描述中的各个功能与数据描述中的静态数据、动态数据之间
的对应关系，例如：
3.2.5性能需求
?时间要求
例如响应时间、更新处理时间、数据转换和传送时间等等。
?适应性（在操作方式、运行环境、与其他软件的接口等发生变化时，所具有的适应能力。）
3.2.6运行环境描述
?硬件设备
?支持软件（操作系统、数据库、其他软件系统如：Lotus Notes等）
?接口（硬件接口、软件接口）
?控制（说明控制该软件的运行的方法）
?用户界面（反映业务流程的用户界面）
?如可用性、安全保密、可维护性、可跨平台性等。（分高、中、低定性详细描述）3.3 概要设计书
3.3.1引言
?编写目的（阐明编写概要设计书的目的，指明读者对象。）
?项目背景（应包括：a.项目的委托单位、开发单位和主管部门；b.该软件系统与其他系统的关系。）
?定义（列出本文档中所用到的专门术语的定义和缩写词的原意。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：立项报告；项目开发计划；需求分析报告；文档所用的资料、采用的标准
或规范。）
3.3.2总体设计
?需求概述
?运行环境
简要的说明对本系统的运行环境（包括硬件环境和支持环境）的规定?处理流程
针对《需求分析报告》中功能需求的功能描述部分，用图的形式表示出完成该功能
的模块的处理流程。并注明各个模块之间的接口参数。
?总体结构
针对《需求分析报告》中功能需求的功能描述部分，用树状图的形式，自顶向下的
表示出完成该功能的所有模块的结构图。
?功能分配（表明各项功能与程序结构的关系。）
用一张矩阵图说明各项功能需求的实现与各模块的分配关系。
3.3.3接口设计
?用户接口
说明向用户提供的命令和它们的语法结构，以及软件的回答信息
?外部接口
说明本系统与外界的所有接口，包括软件与硬件之间的接口，本软件与其他软件之
间的接口关系。
?内部接口
针对在总体设计部分的总体结构中列出的模块树状结构图，对树状图中位于同一层
的各个模块之间的接口进行详细说明。
3.3.4数据结构设计
?逻辑结构设计（数据字典）
?物理结构设计
数据字典的存储要求、访问方法、存取的物理关系（包括索引、设备等等）?数据结构与程序的关系
用一张矩阵图说明各个数据库表与各模块的对应关系。
3.3.5出错处理设计
?出错输出信息
用表的形式说明可能出现的出错或故障情况出现时，系统输出信息的形式，含义以
及处理方法。
?出错处理对策
说明故障出现后可能采用的补救措施，包括：
后备技术：当原始数据丢失时起用数据副本的技术
性能降级：当系统崩溃时，暂时采用人工处理的办法
恢复及再启动：是软件从故障点恢复执行或使软件从头开始运行的方法
3.3.6安全保密设计
指从系统安全保密角度考虑，在程序设计和数据库设计中作出的一些安排。例如为了保证传输数据的完整性与保密性，需要在传递数据前对数据进行加密。
系统维护设计
说明为了系统维护的方便而在程序设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。
3.4 详细设计书
3.4.1引言
?编写目的（阐明编写详细设计书的目的，指明读者对象。）
?项目背景（应包括：a.项目的委托单位、开发单位和主管部门；b.该软件系统与其他系统的关系。）
?定义（列出文档中所用到的专门术语的定义和缩写词的原意。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：项目的计划任务书、合同或批文；立项报告.；项目开发计划；需求分析
报告；概要设计书；测试计划；文档中所引用的其他资料、软件开发标准或规范。）3.4.2总体设计
?需求概述
?软件结构（如给出软件系统的结构图。）
对《概要设计书》中的总体结构部分的各个模块，用列表的方式给出该模块包含的
程序的名称、标识符、功能列表。
3.4.3程序描述
（逐个程序给出以下的说明：）
?功能
说明该程序应具有的功能。
?性能
说明对该程序的性能要求，包括精度、灵活性、时间特性等要求。
?输入项目
给出每一个输入项目的特性，包括名称、标识符、数据的类型和格式、数据值的有
效范围、输入的方式、输入媒体等等。
?输出项目
给出每一个输出项目的特性，包括名称、标识符、数据的类型和格式、数据值的有
效范围、输出的形式、输出媒体等等。
?算法
本程序所选用的算法，具体的计算公式和计算步骤。
?流程逻辑
用流程图的形式辅以必要的说明来表示本程序的逻辑流程。
?接口
说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数
赋值和调用方式，说明与本程序直接关联的数据库。
?限制条件
?测试要点（给出测试模块的主要测试要求。）
?尚未解决的问题
3.5 测试计划
3.5.1引言
?编写目的（阐明编写测试计划的目的并指明读者对象。）
?项目背景
?本测试计划所从属的软件系统的名称；
?项目的委托单位、开发单位和主管部门；
?该软件系统与其他系统的关系。
?定义（列出测试计划中所用到的专门术语的定义和缩写词的原意。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.项目的计划书、合同或批文；b.项目开发计划；c.需求分析报告；d.概要
设计书；e.详细设计书；f.用户手册；g.本测试计划中引用的其他资料、采用的软件
开发标准或规范。）
3.5.2计划
?测试方案（说明确定测试方法和选取测试用例的原则如：用户界面测试、功能流程测试、性能测试。）
?测试项目（列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。）?测试准备
?测试机构及人员（测试机构名称、负责人和职责。）
3.5.3测试项目说明
（按顺序逐个对测试项目做出说明：）
?测试项目名称及测试内容
?测试用例
1.输入（输入的数据和输入命令。）
2.输出（预期的输出数据。）
3.步骤及操作
?进度
?条件（给出项测试对资源的特殊要求，如设备、软件、人员等。）
?测试资料（说明项测试所需的资料。）
3.5.4评价
?范围（说明所完成的各项测试说明问题范围及其局限性。）
?准则（说明评价测试结果的准则。）
3.6 测试报告
3.6.1引言
?编写目的（阐明编写测试报告的目的并指明读者对象。）
?项目背景
?本测试计划所从属的软件系统的名称；
?项目的委托单位、开发单位和主管部门；
?该软件系统与其他系统的关系。
?定义（列出测试报告中用到的专门术语的定义和缩写词的原意。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.项目的计划任务书、合同或批文；b.项目开发计划；c.需求分析报告；
d.概要设计书；
e.详细设计书；
f.用户手册；
g.测试计划；
h.所引用的其他资料、采
用的软件工程标准或软件工程规范。）
3.6.2测试计划执行情况
?测试项目（用表格的形式列出每一测试项目的名称、内容和目的。）
?测试机构和人员（给出测试机构名称、负责人和参与测试人员名单。）
?测试结果（按顺序给出每一测试项目的：a.实测结果数据；c.该项测试表明的事实；
d.该项测试发现的问题。）
软件需求测试结论
?顺序给出每一项需求测试的结论。包括：a.证实的软件能力；b.局限性（哪项需求未得到充分测试的情况及原因。）
3.6.3评价
?软件能力（经过测试所表明的软件能力。）
?建议（提出为弥补上述缺陷的建议。）
?缺陷和限制（说明测试所揭露的软件缺陷和不足，以及可能给软件运行带来的影响。）
?测试结论（说明能否通过。）
3.7 模块开发文档
3.7.1功能说明
说明本模块或本组模块的功能，主要是输入、要求的处理、输出，并附上《需求分析报告》中对这些功能的说明部分。
3.7.2设计说明
说明本模块的设计考虑，包括：
1.在《概要设计书》中对本模块（或本组模块）设计考虑的叙述，包括本模块在软件
系统中所处的层次，它同其他模块的接口。
2.在《详细设计书》中对本模块（或本组模块）的设计考虑，包括本模块的算法、处
理流程、出错信息等等
3.在编写源代码时实际使用的设计考虑
3.7.3源代码清单
给出已通过全部测试的源代码清单。
3.7.4测试说明
说明该模块自测试的目的、输入、预期的输出和实际的输出。
3.7.5复审结论
把实际测试的结果，同《需求分析报告》、《概要设计书》、《详细设计书》中规定的要求进行比较并给出结论。
3.8 用户手册
3.8.1引言
?编写目的（阐明编写用户手册的目的并指明读者对象。）
?项目背景
?本用户手册所从属的软件系统的名称；
?项目的委托单位、开发单位和主管部门；
?该软件系统与其他系统的关系。
?定义（列出用到的专门术语的定义和缩写词的原意。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.项目的计划任务书、合同或批文；b.项目开发计划；c.需求分析报告；
d.概要设计书；
e.详细设计书；
f.测试计划；
g.所引用的其他资料、采用的软件工程
标准或软件工程规范。）
3.8.2系统功能介绍
按照软件使用者的一般工作分工说明软件所具有的功能、这些功能帮助使用者解决实际工作中的哪些问题、使用软件后的优点。
3.8.3运行环境说明
简单说明运行本软件所要求的：
?硬件设备环境，例如使用什么型号的计算机、配备多少内存及硬盘等；
?系统软件的环境，例如WINDOWS、SQL*NET等；
?应用软件环境，例如运行本软件时需要在系统中有哪些其他子系统的支持等。
必要时可以说明软件运行的基本环境和最佳环境。
3.8.4运行前的准备
说明这个软件在运行前用户应该作的准备工作，如：代码的编制、数据的准备、工作流程的调整等等。在这里应该列出所需要做的准备工作清单，以告诉用户在使用前应做好的准备工作。有些系统初始化的工作，特别是需要系统维护人员操作的安装和初始化工作操作方法可在后面附录的安装与初始化中描述，在这里不必详细说明。
3.8.5输入输出说明和操作说明
这一部分是用户手册的核心，这部分内容应该按照工作的流程顺序来编写。
对于每个相对独立运行的子系统或程序模块，应说明软件的进入和退出方法。（在WINDOWS环境下的软件只需说明快捷方式启动软件的方法即可，通常情况下不必再说明用命令启动软件的方法。）
在编写操作说明时为了用户使用的方便，应该针对每一个工作流程编写相应的软件操作步骤和方法，其内容应该包括：
?功能简介。
?工作流程中相应软件模块的进入与退出方法。
?以醒目的方式列出常规工作时操作步骤，详细说明每个步骤中的屏幕和使用方法?这一部分应该尽量让软件的使用操作人员对整个操作过程有一个明确的概念，在文件编排上应该把使用者的注意力集中在使用软件解决他工作中的问题上。
?对向计算机输入的数据和计算机输出的内容给予适当的说明。
在语言上应该使用易于用户理解的词汇而尽量不要用计算机专业术语。
3.8.6安全与保密
说明软件对保密管理的要求及违反保密规定后可能造成的后果。在一些子系统中，保密字乱用后，可能造成个人工作量统计错误等等。
3.8.7常见问题的处理
根据需要说明在使用中可能遇到的问题及其解决方法。这些问题往往是由于在使用过程中的错误操作造成的。对于一些能够预见的，经常可能遇到的问题应该在用户手册中提供解决的方法，这样能够减少很多为用户提供使用咨询的工作量。
3.8.8附录：安装与初始化
?安装
列出软件安装的步骤，说明安装过程中的每一步操作方法。这一部分的内容应该让
初次接触这个系统的使用者依照手册中所列的步骤和操作方法顺利地将软件安装
上。
?初始化
列出软件正式运行前所需要进行初始化工作的清单和初始化操作的步骤。对于初始
化中的每个步骤应给予适当的说明，使进行初始化工作的人能够充分理解初始化中
每一步骤的实际作用，以便于合理地配置应用系统，充分发挥系统的作用
3.9 试运行计划
3.9.1引言
?编写目的（阐明试运行计划的目的并指明读者对象。）
?项目背景
?软件系统的名称；
?项目的委托单位、开发单位和主管部门；
?该软件系统与其他系统的关系。
?定义（列出文档中用到的专门术语的定义和缩写词的原意。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.项目的计划书、合同或批文；b.项目开发计划；c.需求分析报告；d.概要
设计书；e.详细设计书；f.用户手册；g.测试计划；h.所引用的其他资料、采用的软
件工程标准或软件工程规范。）
3.9.2开发背景介绍
包括业务需求提出的起因、项目负责人、开发人员（开发商）、测试负责人、业务系统涉及部门
3.9.3运行环境介绍
硬件设备、网络环境、软件平台等等
3.9.4软件流程及模块功能说明
提供一份图表或流程图，并逐项说明软件系统各个模块的功能、输入和输出的业务数据的提纲。
3.9.5试运行所需资料
包括用户使用手册、规范的业务操作流程、业务数据、问题记录表等。
3.9.6特殊业务的处理方法说明
3.9.7试运行所需的业务基础数据
3.9.8试运行进度安排
3.10 验收报告
3.10.1引言
?编写目的（阐明编写验收报告的目的并指明读者对象。）
?项目背景
?软件系统的名称；
?项目的委托单位、开发单位和主管部门；
?该软件系统与其他系统的关系。
?定义（列出验收报告中用到的专门术语的定义和缩写词的原意。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.项目的计划书、合同或批文；b.项目开发计划；c.需求分析报告；d.概要
设计书；e.详细设计书；f.用户手册；g.测试计划；h. 所引用的其他资料、采用的
软件工程标准或软件工程规范。）
3.10.2验收内容
验收的基本内容应基于项目开发合同。
?文档（列出每一阶段提交的文档的名称、内容和评价。）
?程序（对于每一子功能的功能测试情况，界面与操作评价，此部分应基于《需求分析报告》和《概要设计书》）
3.10.3软件验收结论
?是否通过验收
?评价
规章制度流程类文件编制规范
精心整理 规章制度编制规范 一、规章制度的结构 （一）规章制度的结构一般由名称、题注、正文三部分组成。正文由总则、分则、附则等组成。 1、总则的内容主要包括：制定规章的目的、依据、原则、适用范围、应对的主要风险（可选项）等。 制定 等。 二、规章制度的名称规范 （一）规章制度的命名应当概括出制订规章制度调整的对象，命名应当完整、准确、简洁。 （二）规章制度命名一般结构为：单位名称+调整对象+名称类别（制度、办法、规定、细则）。
（三）某些规定性的规章制度，因为客观要求需要尽快增加新的内容，对原规章制度内容并不改变的，为避免因修订程序延误时间，可以制定“补充规定”。 （四）规章制度标题的题注应当载明制定(或修订)机构、制定(或修订)日期。 三、规章制度制定目的和依据规范 （一）制定规章制度的目的和依据是规章制度的必备条款，应当在规章制度的“第一条”做出表述。 （二）制定规章制度的目的是指所制定的规章制度要获得的直接结果的高度概括。按照具体到 1XX规2 3 遵守本规定的规定”。 （四）行为，指规章制度所调整的行为。如“本规定适用于分中心单证操作 及相关活动”。 （五）物，指规章制度所调整的物。如“本规定适用于公司***相关业务”。 （六）规章制度适用的表述，应当结合实际需要，可以是空间、人、行为和物的单一表述，也可以组合表述（一般按照“本规定适用于……空间……行为……物、人”的顺序表述）。 五、规章制度确定的管理机构规范
（一）管理机构是指规章制度确定的主要管理某一方面工作的部门或协助管理某一方面工作的部门，其表述应当遵循以下原则： 1、主管部门的表述有实写（如财务部）和虚写（如各业务部门）两种方式。一般采用虚写的方式，虚写可以避免因部门名称的变更而频繁修改规章。但是如果虚写指代不明，难以认明该表述实指哪一个部门，或者会产生歧义时，则应当实写。 2、一个规章制度一般明确一个主管部门；不便统一管理的可以明确分别主管的部门；需要在统一主管部门下分管的，可以明确统一主管部门和分工主管部门。 3、既有主管部门又有协管部门的可以明确主管部门和协管部门。 1 2XX工作3C、D部门 等。 “责 1、原则表述：“对XXXXXX成绩突出的，给予表彰和物质奖励”； 2、具体表述：“对XX成绩突出的，给予表彰，并根据创造XX效益或挽回经济损失的大小，分别给予XX元至XX元的奖励”。 （五）规章制度对处罚的规定，通常采取以下方式： 1、条文对应表述：依次引述规章制度中设定的违规行为的有关条款序号，然后表述所给予的相应处罚。如“违反本规定第X条（第X款）规定的，根据情节轻重，给予通报批评、XXXXXX、解除劳动合同等处罚种类，也可原则规定经济处罚”。
软件技术文档编写规范
目录 第一章引言 1 §1.1 目的 1 §1.2 文档约定 1 §1.3 预期读者和阅读建议 1 §1.4 产品的范围 1 §1.5 参考文献 1 第二章综合描叙 1 §2.1 产品的前景 1 §2.2 产品的功能 1 §2.3 用户类和特征 2 §2.4 运行环境 2 §2.5 设计和实现上的限制 2 §2.6 假设和依赖 2 第三章外部接口需求 2 §3.1 用户界面 2 §3.2 硬件接口 3 §3.3 软件接口 3 §3.4 通信接口 3 第四章系统特性 3 §4.1 说明和优先级 3 §4.2 激励响应序列 3 §4.3 功能需求 3 第五章其他非功能需求 3 §5.1 性能需求 3 §5.2 安全设施需求 4 §5.3 安全性需求 4 §5.4 软件质量属性 4 §5.5 业务规则 4 §5.6 用户文档 4 第六章其他需求 4 §6.1 词汇表 4 §6.2 分析模型 4 §6.3 待确定问题列表 5 第1章引言 引言提出了对软件需求规格说明的纵览，这有助于读者理解文档如何编写并且如何阅读和解释。 §1.1 目的 对产品进行定义，在该文档中详尽说明了这个产品的软件需求，包括修正或发行版本号。如果这个软件需求规格说明只与整个系统的一部分有关系，那么就只定义文档中说明的部分或子系统。 §1.2 文档约定
描述编写文档时所采用的标准或排版约定，包括正文风格、提示区或重要符号。例如，说明了高层需求的优先级是否可以被其所有细化的需求所继承，或者每个需求陈述是否都有其自身的优先级。 §1.3 预期读者和阅读建议 列举了软件需求规格说明所针对的不同读者，例如开发人员、项目经理、营销人员、用户、测试人员或文档的编写人员。描述了文档中剩余部分的内容及其组织结构。提出了最适合于每一类型读者阅读文档的建议。 §1.4 产品的范围 提供了对指定的软件及其目的的简短描述，包括利益和目标。把软件与企业目标或业务策略相联系。可以参考项目视图和范围文档而不是将其内容复制到这里。 §1.5 参考文献 列举了编写软件需求规格说明时所参考的资料或其它资源。这可能包括用户界面风格指导、合同、标准、系统需求规格说明、使用实例文档，或相关产品的软件需求规格说明。在这里应该给出详细的信息，包括标题名称、作者、版本号、日期、出版单位或资料来源，以方便读者查阅这些文献。 如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 第2章综合描叙 这一部分概述了正在定义的产品以及它所运行的环境、使用产品的用户和已知的限制、假设和依赖。 §2.1 产品的前景 描述了软件需求规格说明中所定义的产品的背景和起源。说明了该产品是否是产品系列中的下一成员，是否是成熟产品所改进的下一代产品、是否是现有应用程序的替代品，或者是否是一个新型的、自含型产品。如果软件需求规格说明定义了大系统的一个组成部分，那么就要说明这部分软件是怎样与整个系统相关联的，并且要定义出两者之间的接口。 §2.2 产品的功能 概述了产品所具有的主要功能。其详细内容将在 d 中描述，所以在此只需要概略地总结，例如用列表的方法给出。很好地组织产品的功能，使每个读者都易于理解。用图形表示主要的需求分组以及它们之间的联系，例如数据流程图的顶层图或类图，都是有用的。 §2.3 用户类和特征 确定你觉得可能使用该产品的不同用户类并描述它们相关的特征（见第7 章）。有一些需求可能只与特定的用户类相关。将该产品的重要用户类与那些不太重要的用户类区分开。 §2.4 运行环境 描述了软件的运行环境，包括硬件平台、操作系统和版本，还有其它的软件组件或与其共存的应用程序。
产品说明书和用户文档集撰写要求概论
附件4：产品说明的提交要求 说明：红字条款可根据软件产品实际情况进行剪裁，黑字条款为标准要求必须说明的项目。斜体字是对国家标准条款的解读或举例，仅供使用者参考。 一、产品说明： 【定义】 陈述软件各种性质的文档，目的是帮助潜在的需方在采购前对该软件进行适用性评价。 解读：产品说明为供方在进行产品销售时对产品性质的宣传资料，目的是让采购方获得产品概况，判断该产品是否能够满足自己的需求，进而决定是否采购该产品。 【要求】 产品说明对于需求方是可用的，包含潜在需方所需的信息，信息内容应排除内部的不一致，且与用户文档集和软件实际情况一致，产品说明的内容应该是可以验证或测试的，产品说明应有唯一性标识，当产品说明内容超出一页文档时，要有封面和目录，方便使用者进行内容查找。 【内容】 1、软件产品应以其名称、版本和日期指称； 解读：软件产品要用名称+版本或名称+日期命名。 例如：城市水资源管理系统软件V1.0或城市水资源管理系统软件2011。 2、产品说明应显示唯一的标识； 解读：产品说明在封面或卡片的显著位置显示唯一的产品标识。 例如：城市水资源管理系统软件V1.0产品说明。 3、产品说明应包含供方和至少一家销售商（当适用时）电子商务销售商或分销商的名称和地址（邮政的或网络的）。 解读：产品说明在封面或卡片的显著位置显示供方和销售商信息一般包括名称和地址，且供方和销售商可以为同一企业或个人。 4、产品说明应标识该软件能够完成的预期的工作任务和服务； 解读：此项描述软件的销售方向，适用的行业，潜在的客户群，概要介绍软件的用途。
例如：本软件为水务行业管理软件，适用于各供水公司、净水厂、水污染处理企业、政府水资源行业管理部门，可完成水资源相关业务的管理及实施对水资源处理装置的动态监控和实时处理。 5、供方想要声称软件产品符合由法律或行政机构界定的要求时，产品说明应标识出这些法律或行政机构界定的要求的需求文档； 解读：供方为加大产品的宣传力度，增强产品竞争力，更好的销售其软件产品，可表明其产品符合法律或行政机构界定的要求。但必须将符合的内容在产品说明中进行详细说明。 例如：本软件符合中华人民共和国水利行业标准SL475-2010水利信息公用数据元标准，该标准的详细信息参见附录一 6、产品说明应以适当的引用文档指名产品在何处依赖于特定软件和（或）硬件；解读：当产品在某些情况下需要依赖于特定的软件和（或）硬件才能实现其生成的产品性质时，要对这些特定的软件和（或）硬件进行描述，以便采购方在采购产品时能够合理评价采购成本。 例如：本软件在对水资源处理装置进行远程动态监控及实时处理时如传输距离超过50米需要信号放大器或无线信号发射器与无线信号接收器 7、产品说明引证已知的对其他软件的用户可调用的接口时，应标识出这些接口或软件； 解读：如果软件再使用过程中需要调用其他软件许可的接口时，应说明这些接口或软件从而使采购方在选择该产品时，明确还需购买其他接口许可或软件。 例如：本软件运行时需要调用水资源信息实时处理业务系统V1.0 8、产品说明应指明产品期望在单一系统上供多个并发最终用户使用或供一个最终用户使用，并且应说明在所要求的系统的所陈述的性能级别上可行的最大并发最终用户数； 例如：当软件支持并发时，此处可进行如下类似描述：本软件在单一系统上可供多个并发最终用户使用，在服务器主频大于3.0GHZ、内存大于2GB、响应时间小于5秒的情况下最大100并发最终用户。 当软件不支持并发时，此处可进行如下类似描述：本软件在单一系统上只供一个最终用户使用，不支持并发操作。
管理制度编制格式规范
管理制度编制格式规范-标准化文件发布号：（9456-EUATWK-MWUB-WUNN-INNUL-DDQTY-KII
管理制度编制格式规范 1 制度名称制度名称由“文件适用范围”＋“文件使用事项”＋“文件种类”构成。例如：“公司车辆管理制度”由适用范围“公司”、适用事项“车辆”和文件种类“管理制度”组成。 2 制度正文 2.1 制度正文由“总则”＋“分则”＋“附则”构成。 2.2 总则：简要说明制订制度的目的、要求、依据、适用范围、有关概念及名词解释等。例如：公司车辆管理制度目的：规范公司车辆管理依据：略适用范围：适用于公司所有车辆的管理相关概念：必要时说明 2.3 分则：按章写，每章用标题标出该章的内容。例如：公司车辆管理制度由“车辆购置”、“车辆调配”、“车辆驾驶”、“车辆保管”等构成。 3 附则说明该制度与其它制度之间的关系。如该制度与其它制度发生矛盾怎么处理、该制度有无实施细则等。如果没有则不写。 说明该制度的制订权、修订权、解释权、实施细则的制订归属。 说明该制度的生效日期、有效期。 说明该制度及实施细则的批准权、执行中的监督管理等事项。 4 关于制度条款标号根据ISO9001（质量体系认证）的要求和实行计算机管理的需要，标号方法统一为：1;1.1;1.1.1;…… 5 关于“制度”与“规定（或办法）”的使用 5.1 一般情况下，若比较系统且较长时间使用的，可定为“制度”，否则定为“规定”。 5.2 根据习惯用法来确定。例如：“养老金管理制度”比“养老金管理规定”更为普遍。 6 “细则”的制订规范参照制度编写规范进行 7 具体内容编排如下： 7.1 题目：小二号、黑体、加粗、居中；题目与一级标题之间用五号字间距空一行 7.2 一级标题：小三号、黑体； 7.3 二、三级标题：四号、仿宋_GB2312、加粗；若二级标题后有三级或者四级标题，则二级标题全部加粗；若二级标题后仅有段落文字，只需将阿拉伯数字加粗；三级标题后若需四级标题详细说明，则三级标题全部加粗；若三级标题后仅有段落文字，只需将阿拉伯数字加粗；四级标题无需加粗，若四级标题后还需增加内容，则用“a)、b)、 c)”字样编写；后续内容可直接首行缩进2个字符无限编写。 7.4 正文内容:四号、仿宋GB2312、行距1.5倍、首行缩进2个字符、段落前的阿拉伯数字与正文内容统一空2个字符； 7.5 页眉、页脚：五号、仿宋；页眉左侧为公司标识，右侧为文档名称；页脚由页码“-*-”的字样居中，若文档为保密性文件，需在右下方加“此文件属公司内部资料未经许可不得外传”的字样； 7.6 若文档中包含表格，则标题为小二号、黑体、加粗、居中；表格内容为五号、仿宋GB_2312、居中。 2
规章制度编写规范
规章制度编写规范 第一条本规范适用于公司所有单体制度。制度起草时须严格遵循规范进行起草，公文印发时的制度附件也须符合本规范。 制度汇编或单行本的印刷版式、打印设置、装订要求须遵照公司的印刷要求进行排版、印刷、装订，此处不另行规范。 第二条制度编写总体要求 （一）依法合规：制度应正确体现法律法规、相关政策及公司上位制度要求，不得与上位规定存在矛盾或冲突。 （二）全面具体：制度应将所涉业务逐一阐明，制度内容详尽，流程明确，体现闭环管理的思路。对所规定的适用范围、操作步骤、评价标准等要具体、明确。 （三）严谨规范：制度撰写时应按照制度示例进行撰写，符合格式规范。制度的行文用语应尽量准确，不使用弹性语言和模糊性描述。 第三条制度标题规范 （一）制度统一按照“适用范围+制度内容+体现制度级别的名称”进行命名。“适用范围”是指该制度施行时所涵盖的范围，如“国家能源集团乌海能源有限责任公司”等；“制度内容”是指该制度针对哪个领域或业务进行规范，如“煤矿安全管理”等；“体现制度级别的名称”指符合相应级别的规范名称，如“章程”，“规定”、“办法”、“细则”等。
（二）制度的“试行”、“暂行”等版本，应加括后在标题下方标注。正式版本的制度，应在标题下方的括号中标明当次修订的年、月，如XXXX年XX月修订。 第四条制度结构规范 （一）制度一般包括以下内容： 1.第一章为总则，规定本制度的目的、依据、适用范围、执行原则、关键名词术语解释等。 2.第二章为组织与职责，规定业务相关的组织体系、管理模式以及相关组织和部门（中心）的职责等。 3.关于制度的执行监督、检查以及相应的考核、问责等内容，一般应独立成章，置于附则之前。 4.最后一章为附则，规定一般名词术语解释、所属单位实施说明、解释权归属、生效日期、修订记录等未尽事宜。 5.除上述四章之外，中间各章规定具体的业务流程、执行标准、管理措施等。 6.附则之后，给出制度的附件列表。 （二）根据内容的复杂程度，制度的体例结构可依次分为“章”、“节”、“条”、“款”、“项”、“目”。 1.“章”是制度内容划分的基本单元，以中文数字配合文字依次表述，如“第一章”、“第二章”。编号应从“总则”章开始直到“附则”结束。
文档编写规范-模板
XXX有限公司文档编写规范
*变化状态：A——增加，M——修改，D——删除
目录 前言................................................................................................................................................................ - 4 -第1章（居中/二号/宋体/TIMES NEW ROMAN/加粗/另起一页）................................................... - 5 - 1.1 （偏左/三号/黑体/Arial/加粗） ............................................................................................ - 5 - 1.1.1 （偏左/三号/宋体/Times New Roman/加粗）........................................................... - 5 - 1.1.1.1 （偏左/四号/黑体/Arial/加粗） ...................................................................... - 5 -
前言【本部分可以有，也可以没有，根据实际情况自定】时间:2010-12-15
第1章（居中/二号/宋体/Times New Roman/ 加粗/另起一页） 1.1 （偏左/三号/黑体/Arial/加粗） 【具体内容】 1.1.1 （偏左/三号/宋体/Times New Roman/加粗） 【具体内容】 1.1.1.1 （偏左/四号/黑体/Arial/加粗） 【具体内容】 贴图格式（居中） 序号格式 1. ● ● ● 2. 3.
流程制度文件编写规范要求(模板)
1.目的（宋体、加粗、小四号字体） 2.适用范围（宋体、加粗、小四号字体） 2.1.（重点描述流程所适用的组织范围和业务范围。） 2.2.（正文文本采用宋体、五号字体、1.5倍行距。） 3.定义（宋体、加粗、小四号字体） 3.1.（重点描述需要说明的专业术语或关键事项。） 3.2.（表格文本采用宋体、10号字体，表头文字加粗、文本居中。）3.3.（表格外框用1.5磅线条，表格内框用0.5磅线条。） 4.关键角色及应负责任（宋体、加粗、小四号字体） 4.1.(重点阐述执行此流程的角色分工和职责。) 4.2.（表格文本采用宋体、10号字体，表头文字加粗、文本居中。）4.3.（表格外框用1.5磅线条，表格内框用0.5磅线条。） 5.流程图（宋体、加粗、小四号字体） 5.1.（用流程图直观的描绘该项流程进行的步骤。） 5.2.（管理制度文件无需绘制流程图。） 5.3.（流程图说明和编制另行规定。） 6.工作程序（宋体、加粗、小四号字体）
6.1.（按活动逻辑顺序描述活动的细节，重点描述活动编号、活动名称、执行角色、活动描 述、输入和输出的信息。） 6.2.（表格文本采用宋体、10号字体，表头文字加粗、文本居中。） 6.3.（表格外框用1.5磅线条，表格内框用0.5磅线条。） 6.4.（管理制度文件可以用文字逐条描述，无需采用下面的表格。） 7.相关文件（宋体、加粗、小四号字体） 7.1.（描述支撑所编写文件的文件，即在活动执行过程中需要涉及的流程文件。） 7.2.（表格文本采用宋体、10号字体，表头文字加粗、文本居中。） 7.3.（表格外框用1.5磅线条，表格内框用0.5磅线条。） 8.相关表单（宋体、加粗、小四号字体） 8.1.（描述执行所编写文件在执行过程中所产生的表格、单据。） 8.2.（表格文本采用宋体、10号字体，表头文字加粗、文本居中。） 8.3.（表格外框用1.5磅线条，表格内框用0.5磅线条。） 9.附则（宋体、加粗、小四号字体） 9.1.（是所编写文件的附属部分，描述与过去类似文件的关系。） 9.2.（正文文本采用宋体、五号字体、1.5倍行距。）
技术文档模板
输入文档名称 内部文件：[输入文件版本号] 颁布时间：[输入颁布时间]
目录 文件版本说明 (2) 参考资料 (2) 手册目的 (2) 声明 (2) 名词定义和缩略语说明 (2) 1 [输入第一章标题] (3) 1.1 [输入第一章第一节标题] (3) 1.1.1 [输入第一章第一节第一小节标题] (3) 1.1.2 [输入第一章第一节第二小节标题] (3) 1.2 [输入第一章第二节标题] (3) 2 [输入第二章标题] (4) 2.1 [输入第一章第一节标题] (4) 2.2 [输入第一章第二节标题] (5) 表格 表 1-1 [输入表格标题] (3) 表 1-2 [输入表格标题] (3) 图表 图1-1 [输入图片名称] (4) 图2-1 [输入图片名称] (4)
文件版本说明 表 1 版本说明 参考资料 1.[列出参考资料名称] 2.[列出参考资料名称，需增加参考资料项，请在行末回车] 手册目的 [请对撰写本手册目的进行适当描述] 声明 [对本文档内容进行声明] 名词定义和缩略语说明 表 2 名词定义及缩略语说明
1[输入第一章标题] [输入正文] 1.1 [输入第一章第一节标题] [输入正文] 1.1.1[输入第一章第一节第一小节标题] [输入正文] 表 1-2 [输入表格标题] 1.1.2[输入第一章第一节第二小节标题] [输入正文] 1.2 [输入第一章第二节标题] [输入正文]
图1-1 [输入图片名称] 2[输入第二章标题] [输入正文] 2.1 [输入第一章第一节标题] [输入正文] 图2-1 [输入图片名称]
文件编写规范
密级：内部公开 文档编号： 版本号：V1.0 分册名称：第1册/共1册 文件编写规范 xxx科技有限公司 编制：生效日期： 审核：批准：
文件更改摘要 日期版本号修订说明修订人审核人批准人
目录 1.目的和范围 (4) 2.目标 (4) 3.术语表 (4) 4.文档编号规则 (5) 5.文档命名规范 (5) 6.文件结构规定 (6) 7.封面 (7) 8.修订页 (8) 9.正文内容格式 (8) 10.文件版本号和文件命名规定 (9) 10.1.文件版本号规定 (9) 10.2.文件命名规定 (9)
1.目的和范围 ●背景说明：本文件作为公司内部文档管理文件，所有公司内编写的文档，均应遵 守本规定，作为公司的所有文档编写统一要求。 ●范围：所有的CMMI执行过程中产生的文档，均应当执行本文件要求作为基础的要 求，如果该部分的体系文件存在明确的要求的，按照体系文件要求执行，没有的则按照本文件执行。 2.目标 规范和统一公司管理体系中所有相关文件的风格和样式，指导公司程序文件、模版文件以及各种记录文件的编写。 3.术语表 ●文件标识：文件的属性标志，包括文件名称、文件编号、版本、生效日期、 审批状态、密级等。 ●程序文件：描述为完成管理体系中所有主要活动提供方法和指导，分配具体的职责 和任务而定义的文件。 ●模版文件：为了使管理体系有效运行，组织统一设计的一些实用的表格和给出活动 结果的报告，规范记录组织的管理体系运行情况。 ●记录文件：简称记录，是组织根据设计的模版和体系要求，填写的表格或者给出活 动结果的报告，作为管理体系运行的证据。 ●修订页：记录文件的修订历史，所有程序文件、除了表格以外的模版和记录都需要 有变更履历，一般位于程序文件的第二页。 ●文档密级：指本文档的保密程度，共分绝密、机密、秘密、内部公开、公开五级制 度。 ●绝密：涉及公司与客户或上游供应商，下游分销商所签订相关的文档资料。仅 限于公司最高管理层及各资料所涉及的经过相应管理人员授权的相关人员查 阅。 ●机密：公司内部所相关的规章制度及技术规范，开发手册等；还有各项目开发 文档、管理文档及软件产品等仅供相关部门高级领导以及经过授权后相关人员 查阅。 ●秘密：需交付用户或与客户进行交流的文档与产品，可供相关项目客户查阅。 ●内部公开：内部不限制，公司内部任何可以任何形式获得文档的信息并阅读、 保存、修改后自用等等，但是不允许向外传播的文件。 ●公开：项目组开发过程中的自用文档或面向售前工作的部分项目介绍材料等。 ●版本标识：作为文档的版本区分。所有发布版本之前不得大于1.0，发布版本作为 1.0，而其后只有重大修改可以调整小数点前的版本号，局部修改调整小数点后版
非常给力的管理制度编写规范
皇明Himin *******控股有限公司 管理制度编写规范 2010年8月3日第4次修订文件编号： 1 目的 为了统一管理文件、制度的编写格式，特制定本规定。 2 适用范围 各部门对手册、程序文件、三阶管理制度（技术图纸标准、检验卡片、工艺卡片等除外）的编制。 3 具体内容 3.1页面设置 3.1.1质量手册、程序文件页边距上、下、右、左全部为2cm，纸型为A4，3.1.2三级管理制度页边距左为2cm，上、下、右全部为1.8cm，纸型为B5（JIS），其它为默认。 3.2 字体及段落设置： 3.2.1 文本所有字体全部为宋体。 3.2.2 除特殊要求外，其他字号全部为小四号字。 3.2.3 输入法状态调整为中文标点，半角字符。 3.2.4 段落设置：行距为固定值，设置值为18磅。 3.3 文件标题： 3.3.1 公司标识和公司名称字号为三号字，公司标识由中英文组合而成，字体加阴影，例如：皇明Himin 温屏Winpin 。 3.3.2编制公司文件时，公司名称统一为“皇明洁能控股有限公司”或“山东温屏节能玻璃有限公司” 3.3.3 正文的标题为小三号字，本行居中。 3.4 版次说明及文件编号： 3.4.1质量手册、程序文件建立封面在封面上描述。见附件1。 3.4.2三级管理制度： a) 标题下行为：文件制定或修订的年月日、版次和文件编号标识，其字号为5号字，且数字全部为阿拉伯数字,并有下划线。 例1：新建版文件 2006年1月1日制定文件编号：
2006年1月1日第1次修订文件编号： b) 第2、3、4……页（含附件）第一行右上角为“文件编号：”字体为五号字。 3.5 页脚设置： 3.5.1质量手册、程序文件无页脚。 3.5.2三级管理制度第一行为下划线，第二行内容为：“共页第页”和“年月日实施”字号为五号字。例如： 第 2 页共8 页年月日实施 注：“文件编号：”“年月日实施”不用填，由图书档案中心发行时填写。 3.6 文件签批栏要求： 每个文件的签批栏为小四号字，在正文尾页底端，即附件（流程图、表格等）前页底端，格式如下： 编制：审核/会签：批准： 3.7 正文内容编写要求： 3.7.1 正文顺序号的书写方法： a) 第一顺序号为1 2 3 ……； b) 第二顺序号为1.1 1.2 1.3 ……； c) 第三顺序号为1.1.1 1.1.2 1.1.3 ……； d) 第四顺序号为a)b)c)……； e) 第五顺序号为①②③……； f) 顺序号后无标点符号，用一个半角空格隔开。 g) 第一、二、三顺序号一律无缩进，第四、五……顺序号向右缩进一个半角空格。 3.7.2 第一顺序号和标题字体加粗后加冒号，内容另起一行。例如：“1 目的：”。 3.7.3 文件修订时原则上使用原文件名称和编号，若文件有以上变化时，须在2 适用范围的内容后加注，例如：“注：本规定代替原2008.5.13版S-0535《制度、流程编写规则》”。 3.7.4 文中所有批注内容字号均为5号字。
技术文件资料编写内容
第六部分供应商须知附表 序号容说明与要求 1 采购人名称省地质环境监测总站 2 供应商的资质要求具备三级以上（含三级）物业服务企业资质 3供应商应提交的商务文件 (1) ★报价函； (2) ★法定代表人授权委托书，如法定代表人参加报价， 提供法定代表人复印件； (3) ★营业执照副本复印件； (4) ★按照“供应商的资质要求”规定提交相关证明材料 复印件； (5)用于评审的证明材料： 1)小型、微型企业产品价格需扣除的，须提供： ①《中小企业声明函》、《从业人员声明函》； ②上一年度资产负债表、损益表的复印件。 ③如供应商为监狱企业，须提供省级以上监狱管理局、戒 毒管理局（含生产建设兵团）出具的属于监狱企业的 证明文件复印件。 (6)供应商认为需要提供的其他商务文件； 4供应商应提交的技术文件
(7) ★报价一览表； (8) ★报价明细表 (9)服务规偏离表； (10)供应商自行编写的技术文件： ①提供详细可行的服务方案，包括但不限于保洁绿化、秩序维护、设备运行维护、会议室服务、物业档案管理方 案等； ②确保顺利接管的措施； ③管理制度； ④培训方案； ⑤优惠服务承诺； （11）投标人认为需要提供的其他技术文件。 5 供应商应单独提交的文件 单独密封的报价一览表（2 份），均须加盖供应商公章，否则作无效报价处理；单独密封的报价保证金退付表。 6 是否允许联合体报价不允许。 7 是否允许供应商将项目非主体、 非关键性工作交由他人完成 不允许。 8 是否安排现场踏勘是，联系人：笑泉。 9 中小微型企业有关政策
(1)根据工信部等部委发布的《关于印发中小企业划型标准规定的通知》（工信部联企业[2011]300 号）规定执行； (2) 按照《财政部司法部关于政府采购支持监狱企业发展有关问题的通知》（财库【2014】68 号）文件规定，在政府采购活动中，监狱企业视同小型、微型企业，享受评审中价格扣除的政府采购政策。 (3)价格扣除幅度：价格给予8%的扣除。 10 项目预算人民币陆拾伍万元整（￥650,000 元）。 11 报价保证金额人民币壹万叁仟元整(13,000 元)。 12 履约保证金 (1)合同金额的10%，于签订合同前交纳； (2)服务期满无质量问题后退还。 13 公证费/见证费 中标金额的0.8‰（如金额低于500 元的，按500 元计算，金额高于8000 元的，按8000 元计算），于签订合同前向公证机构/律师事务所交纳。 14 付款途径预算国库集中支付 15 付款方式 其他支付方式合同生效之日起20 个工作日，支付合同 金额的25 %；服务期限自第二季度起， 每季度末验收合格支付合同金额的25% 16 接管时间合同生效之日起7 日
需求分析规范——附加说明1用例描述文档编写规范
百度文库 - 让每个人平等地提升自我 需求分析规范 用例描述文档编写规范（精要） 版本 <> 文档编号：001-0002-2
版本历史 日期版本描述作者2006-07-01 <> 初稿整理吕春秋
目录 1.前言5 1.1目的5 1.2范围5 1.3本文档说明5 2.基本要求6 3.用例事件流的描述6 3.1基本事件流的要求7 3.2子事件流的要求7 3.3备选事件流的要求8 3.4事件流中的序号标号9 3.5事件流中“确认”与“执行”操作描述的建议9 4.业务规则的描述9 4.1业务规则的种类9 4.1.1业务规则的抽取及编号10 4.1.2公共业务规则的抽取及编号10 4.2业务规则描述结构10 4.2.1要点说明式10 4.2.2顺序结构11 4.2.3分支结构11 4.2.4循环结构12 4.2.5混合结构13 4.2.6注意事项13 4.3业务规则描述中的缩进规则13 4.4业务规则描述中的标号13 5.子用例的定义与描述13 5.1子用例的设计方法13 5.2子用例中判断上级调用用例的方法13 6.用例描述中的其它规范14 6.1类、属性、参数、值的书写规则14 6.1.1类名的书写规则14 6.1.2属性名的书写规则14 6.1.3参数名的书写规则14 6.1.4各种值的书写规则14 6.2用例描述中的注释信息15 6.2.1注释要求15 6.2.2注释信息的描述15 6.3描述一致性15 7.接口15 8.新一代ERP系统中的几个公共机制15
8.1删除完整性检查15 8.2消息机制16 8.3编号管理16 9.用例描述中用词规范16 9.1范围值的描述16
制度编写书写规范
制度编写书写规范
制度汇编书写规范 书写规范名词解释 ?制度:制度即规程，制度一般指要求大家共同遵守的办事规程或行动准则。 ?规定:规定是强调预先（即在行为发生之前）和法律效力，用于法律条文中的决定。 ?办法：处理事情或解决问题的方法。 ?规范：明文规定或约定俗成的标准。 ?要求：提出具体愿望或条件。 ?通知：通知，是向特定受文方告知或转达有关事项或文件，让对方知道或执行的公文。 ?标准：衡量人或事物的依据或准则。 ?流程：完成一个完整的业务行为的过程，可称之为流程。?准则：行为或道德所遵循的标准原则或是行为准则。 ?细则：细则也称实施细则，是有关机关或部门为使下级机关或人员更好地贯彻执行某 一法令、条例和规定，结合实际情况，对其所做的详细的、具体的解释和补充。 ?试行：有待进一步成熟,以便以后作进一步修改,完善。 ?暂行：一般指文件规定得相对比较简单概括,以便以后修订。 ?修订：修订指的是对文件、书籍、文稿、图表等的修改整
理。 附件2： 制度规范编写要求 GHNY-IAC-2014-V01 制度名称（宋体、加粗、居中、二号字体） 1. 目的（宋体、加粗、小四号字体） 1.1. （重点描述期望达到的目标、能够为公司创造的价值。） 1.2. （正文文本采用宋体、五号字体、1.5倍 行距。） 2. 适用范围（宋体、加粗、小四号字体） 2.1. （重点描述流程所适用的组织范围和业务范围。） 2.2. （正文文本采用宋体、五号字体、1.5倍 行距。） 3. 定义（宋体、加粗、小四号字体） 3.1. （重点描述需要说明的专业术语或关键事项。） 3.2. （表格文本采用宋体、10号字体，表头文字加粗、文本居中。） 3.3. （表格外框用 1.5磅线条，表格内框用 0.5磅线条。） 公司VI 名称，水平180* 垂直31像素。居右 公司Logo ，水平80*垂直64像素。居左 宋体、五号字体、居中，编号规则详见附件2
软件需求说明书编写规范
{产品名称} 软件需求规格说明书 编写人： 编写日期：年月日
目录 1.产品描述 (3) 1.1.编写目的 (3) 1.2.产品名称 (3) 1.3.名词定义（可选） (3) 2.产品需求概述 (3) 2.1.功能简介 (3) 2.2.运行环境 (3) 2.3.条件与限制（可选） (3) 3.功能需求 (3) 3.1.功能划分（可选） (3) 3.2.功能1 (4) 3.3.功能N (4) 3.4.不支持的功能 (4) 4.数据描述 (4) 5.性能需求（可选） (4) 6.运行需求（可选） (4) 6.1.用户界面 (4) 6.2.硬件接口 (4) 6.3.软件接口 (5) 6.4.通信接口 (5) 7.其它需求（可选） (5) 8.特殊需求（可选） (5) 9.不确定的问题（可选） (5) 10.编写人员及编写日期 (5) 11.附录 (5) 11.1.引用文件 (5) 11.2.参考资料 (5)
1.产品描述 1.1.编写目的 【说明编写本软件需求规格说明书的目的，指出预期的读者。】 1.2.产品名称 【本项目的名称，包括项目的全名、简称、代号、版本号。】 1.3.名词定义（可选） 【对重要的或是具有特殊意义的名词（包括词头和缩写）进行定义，以便读者可以正确地解释软件需求说明。】 2.产品需求概述 2.1.功能简介 【对产品的基本功能做一个简介，包括： 1.本产品的开发意图、应用目标及作用范围。 2．概略介绍了产品所具有的主要功能。可以用列表的方法给出，也可以用图形表示主要的需求分组以及它们之间的联系，例如数据流程图的顶层图或类图等。 3．说明本产品与其他相关产品的关系，是独立产品还是一个较大产品的组成部分。 可以用表示外部接口和数据流的系统高层次图，或者方框图说明。】 2.2.运行环境 1.硬件环境： 【详细列出本软件运行时所必须的最低硬件配置、推荐硬件配置(如主机、显示器、外部设备等)以及其它特殊设备。】 2.软件环境： 【如操作系统、网络软件、数据库系统以及其它特殊软件要求。】 2.3.条件与限制（可选） 【说明本软件在实现时所必须满足的条件和所受的限制，并给出相应的原因。 必须满足的条件包括输入数据的范围以及格式。 所受的限制包括软件环境、硬件环境等方面的内容。例如：必须使用或者避免的特定技术、工具、编程语言和数据库；企业策略、政府法规或工业标准；硬件限制，例如定时需求或存储器限制；经费限制、开发期限；项目对外部因素存在的依赖。例如其它项目开发的组件。等等】 3.功能需求 【功能需求描述系统特性，即产品所提供的主要服务。可以通过使用实例、运行模式、用户类、对象类或功能等级等不同方法来描述，还可以把它们组合起来使用。 功能需求的表述形式可以参见《需求分析和管理指南》第8.2节。】 3.1.功能划分（可选） 【此部分从用户的角度描述将软件划分成不同的部分，并给出总体功能结构。对于复杂
管理制度编写规范
管理制度编写规范 1.目的 为规范集团的管理制度的编写格式，统一执行。 2.编写原则及适用范围 2.1管理制度的编写原则 2.1.1部门职责主导：以部门职责为基础，将与职责相关的流程、标准、规定等整理成管理制度。 2.1.2职责无重叠、无空白：部门工作职责清晰明确，各层级和部门职责对应清楚，每项职责都有对应的工作流程，每个流程中的环节都有清晰的工作标准。 2.1.3运行科学高效：节点、岗位设置准确，流程简洁高效，标准科学适用。 2.1.4环节控制，闭环管理：上游为下游服务，下游检验上游工作，流程链上各环节设置工作质量记录，实现流程考核，形成环节控制，闭环管理。 2.1.5形成全面的企业管理制度：所有流程、标准、规定等都形成企业制度，作为员工工作、培训、执行、监督、考核的标准。谁主导谁进行培训。 2.1.6动态管理，持续优化：管理制度不是一成不变的，要随着企业的发展和需要进行调整、修订，始终保证其为企业发展提供有力支撑。 2.2适用范围 本规范是集团制度编写格式、编写要求的指导文件。适用于集团及分公司所有管理制度的编写。 3.术语 3.1集团管理运营中制定的所有规范化文件统称为管理制度。 3.2制度层级：分为两个层级。全集团适用或系统内适用的制度为集团制度，仅适用一个单元的为单元制度。集团制度由集团总部或系统内主导部门负责发布、管理。单元制度由单元发布、管理。 4.职责 企业管理部：负责修订并监管本规范的实施。 5.管理制度的编码 5.1编码原则 采用9位编码，顺序依次为：2位单元编码、2位类目编码、2位系统编码、3位序号编 码，中间以“-”分隔。 □□ - □□ - □□ - □□□
软件开发技术文档编写规范
软件开发技术文档编写规范 在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。 ◇可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。 ◇项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 ◇软件需求说明书（软件规格说明书）：对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。 ◇概要设计说明书：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。 ◇详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 ◇用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。 ◇测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 ◇测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。 ◇开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 ◇项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。 ◇软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。 ◇软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。 ◇软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。 1可行性分析报告 1 引言 1.1 编写目的：阐明编写可行性研究报告的目的，提出读者对象。
企业体系文件编写及管理规定
企业体系文件编写及管理规定： 1.0【目的】 规范公司质量管理体系文件的编写管理要求，保证公司质量管理体系文件资料的标准符合性和格式的一致性及标识的规范化。 2.0【范围】 适用于公司质量管理体系文件资料的编写管理。 3.0【定义】 体系文件：质量管理体系要求的文件结构类文件（质量手册、程序文件、作业指导书、图纸类、技术标准类、检验规范类、质量记录表单等资料）。 4.0【职责】 4.1 管理者代表：负责公司体系文件格式的规范、质量手册的编写和程序文件的审核； 4.2 体系小组成员：负责程序文件的编写和本部门三级文级的编写； 4.3 部门负责人：负责本部门所属文件的审核； 4.4 总经理：负责质量方针和质量目标的拟定及质量手册的审核。 董事长：负责质量方针和质量目标的拟定及质量手册的批准。4.5 4.6 各部门副总：负责本系统部门内各类体系文件的批准。 4.7 文控文员：负责体系文件资料的管理与标识。 5.0 【内容】 5.1 公司体系文件资料的架构组成及编号规则和审批权限：
5.1.1质量体系文件的层次 第一层：质量手册 第二层：程序文件(含过程方法) 第三层：作业指导文件，通常又可分为： * 管理性第三层文件（如：车间管理办法、仓库管理规定、文件和资料编码规定、产品标识细则规定、产品检验状态标识细则规定等） * 技术性第三层文件（如：产品标准、原材料检验规程、抽样标准、技术图纸、工序作业指导书、工艺卡、设备操作规程等） * 外来文件 第四层：质量记录表单类 5.2 体系文件格式要求： 5.2.1 质量手册格式（QM） 1> 封面 2> 颁布令 3> 手册说明（适用范围） 4> 手册目录 5> 修订页 6> 定义部分（如需要） 7> 组织概况（前言页） 8> 组织的质量方针和目标
规章制度编写格式模板(试行)
制度名称（宋体小二、加粗，单倍行距，段前0.5 行，段后0 行） （空一行，行距：固定值10 磅） 1. 一般规定（章：黑体小四、加粗，序号与标题间空二字节间距） 1.1 本规定制定的依据。（节：1.1 、1.2 、1.3. 。。。） 页面设置为A4纵向，上边距2.4cm,下边距2.3cm,左边距2.8cm,右边距 2.5cm。 正文、段落。正文、段落中的中文字体使用小四号宋体,数字及西文为小四号Times New Roman字体，英文词组第一个字母需大写。每段落两端对齐，固定行距 22 磅,段前、段后0行,缩进左、右0 字符。 1.2 本规定适用范围。（所有标题采用黑体小四、加粗） 1.3 本规定解释和修改部门。注：1. （“注：”与“1.”间空一字符,中文宋体和阿拉伯数字Times New Roman三号加粗字体） 注： 1. 对附注内容进行说明时,应在进行标识的段落结束后或图表下方进行说明描述。（中 文小五号仿宋GB2312和西文采用小五号数字Times New Roman字体） 1.4 本规定所涉及的关键术语解释。 1.5 必要的原则和概括性描述。 2. 具体事项 2.1 制度管理内容涉及相关部门和单位的职责分工。 2.2 管理相对人的权利、义务。 2.3 管理的具体要求。 2.4 管理流程（应按实际操作业务流程的逻辑顺序进行描述,可以完全流程化的配套建 立流程,不能完全流程化的要表述清楚）。 2.5 奖惩考核。 2.5.1 条：使用阿拉伯数字对条编序。如：2.5.1 、2.5.2. 。。。。 2.5.2 同一条文中有两个以上（含两个）的条文时,才可细分序号。 2.5.3 条一般不列标题,序号后为正文内容,但有无标题要求全文应进行统 一。 a）列项 b）列项可以在章、节、条、款内独立使用 c）图表：