2023年12月7日发(作者：)
保密等级：内部公开
文档规范说明书
XXX信息技术有限公司
XXX Information Technology Co.，LTD.
2020年3月
文档规范说明书
文档修订历史
序号
1
2
版本
V1.0
创建
修改内容 修改日期
2020-02-26
修改人 审核人
I
文档规范说明书
目 录
1
文档规范背景 ......................................................................................................... 1
1.1
1.2
2
3
文档规范目的 ........................................................................................... 1
使用范围 ................................................................................................... 1
文档内容 ................................................................................................................. 2
文档命名规范 ......................................................................................................... 3
3.1
3.2
3.3
命名规范意义 ........................................................................................... 3
命名原则 ................................................................................................... 3
文档命名结构 ........................................................................................... 3
3.3.1
3.3.2
3.3.3
3.3.4
3.3.5
3.3.6
项目名称 ........................................................................................................... 3
文档名 ............................................................................................................... 4
部分名 ............................................................................................................... 6
日期 ................................................................................................................... 6
版本号 ............................................................................................................... 7
文档后缀 ........................................................................................................... 7
3.4
4
文档名举例 ............................................................................................... 8
文档结构规范 ......................................................................................................... 9
4.1
4.2
页面设置 ................................................................................................... 9
封面 ........................................................................................................... 9
4.2.1
4.2.2
4.2.3
4.2.4
文档标题 ........................................................................................................... 9
公司名 ............................................................................................................. 10
日期 ................................................................................................................. 11
保密等级 ......................................................................................................... 11
4.3
4.4
4.5
4.6
4.7
4.8
文档修订历史 ......................................................................................... 12
目录 ......................................................................................................... 13
页眉页脚 ................................................................................................. 13
标题样式 ................................................................................................. 13
正文 ......................................................................................................... 13
文档属性 ................................................................................................. 13
II 文档规范说明书
5
文档正文规范（建议） ....................................................................................... 14
5.1
字体规范 ................................................................................................. 14
5.1.1
5.1.2
5.1.3
正文 ................................................................................................................. 14
数字规范 ......................................................................................................... 14
英文规范 ......................................................................................................... 14
5.2
5.3
5.4
5.5
5.6
标题编号 ................................................................................................. 14
段落 ......................................................................................................... 15
编号 ......................................................................................................... 15
图片格式 ................................................................................................. 16
表格格式 ................................................................................................. 16
III
文档规范说明书
1 文档规范背景
1.1 文档规范目的
规范公司产品及技术文档体系，加强文档的标准化管理。
加强公司项目文档管理，便于项目人员阅读、修改和跟踪，采用标准化规范对文档进行统一命名，文档格式及要求标准化。
文档命名规范确保公司产品及技术部重要文档具有唯一编号，便于文档的有效识别、追溯和控制，保证部门文档体系有效运转。
对文档格式和内容制定规范，指导各部门各种文档编制工作，规范和统一文档风格 有利于文档保持一致性，提高文档质量。
1.2 使用范围
本规范主要适用于项目的立项书、规划设计方案、建设方案、投标文件及需求分析文档、使用手册、技术开发文档等。
文档命名规范、文档结构规范强制执行，对于段落标题、文档正文规范本规范说明书只是建议。对于招标文件或者客户对文档格式有规定的，文档格式按照要求撰写。
1 文档规范说明书
2 文档内容
文档规范包括文档命名规范、文档结构规范、文档正文规范。
文档命名规范包括文档命名的意义、原则和结构。
文档结构规范包括文档页面设置、封面、修订历史、目录、页眉页脚、标题编号、文档属性等规范。
文档正文规范包括文档正文、段落、编号、图表格式的建议。
2 文档规范说明书
3 文档命名规范
3.1 命名规范意义
1) 让接收方一眼明白文档的主题。
2) 方便快速检索到所需要的文档。
3) 区分版本并随时回溯以前的版本。
3.2 命名原则
1) 命名要有助于文档的排序，便于查找和管理。
2) 命名要能看出文档的内容。
3) 文档命名使用中文、英文字母和阿拉伯数字的组合
4) 文档名组合一般用“_”下划线、“（）”圆括号、“.”点、“[]”六角括号这几种字符，其他字符一般不要使用。
3.3 文档命名结构
文档命名的结构：
[客户名称]项目名称[子系统名称] + 文档名 +（部分名）_日期_V版本号.文档后缀
对于投标文件、招标文件、评审文件或者方案最后提交版后者发布版，可以去掉版本号，改为终稿、发布版或者打印稿
[客户名称]项目名称[子系统名称] + 文档名 +（部分名）_日期_终稿.文档后缀
3.3.1 项目名称
如果同一项目有多个客户的或者项目名比较简单的，可以把客户名称（缩写）加在项目名称之前。
如果一个项目有多个子系统文档，可以加上子系统名称或者直接用子系统名称代替项目名称，或者项目名称用一个缩写代替。
3 文档规范说明书
如果是投标文件或者正式申报文件，把“项目”或者“建设项目”也补齐或者根据招标文件的项目全称来命名。
如果每年都有同样的项目，可以在项目名称上加上年份。
总之，项目名称不能太长，也不能太短，要能体现客户，项目内容，文档内容。
比如：
1） 电信电话会议系统扩容
2） 商贸公司第三方支付平台预付卡系统
3） 智慧校园统一消息推送应用平台服务项目
4） 信息终端技术迭代更新优化实施项目
3.3.2 文档名
工程项目全周期包括了立项阶段、计划阶段、实施阶段和完成阶段。产品及售前部门主要负责项目立项阶段的立项报告、需求调研、方案建议书。计划阶段的招投标文档。实施阶段的的需求分析文档、使用手册等。技术研发部门主要负责技术设计、开发及测试文档的编写。
以下所列是工程项目全周期各阶段的文档名。
项目阶段 工作内容 文档名称
可行性研究报告
项目报审方案
项目规划
立项阶段
产品规格说明书
立项报告
规划设计方案
方案设计
技术方案
方案建议书
招标文件
计划阶段 项目招投标
投标方案
4 文档规范说明书
投标文件（商务部分、报价部分、技术部分、开标一览表）
商务合同及附件
系统总体设计说明书
系统需求规格说明书
需求
软件需求规格说明书
硬件需求规格说明书
结构需求表
接口需求规格说明书
项目计划书
质量保证计划
计划
配置管理计划
进度计划
软件概要设计说明书
设计
实施阶段
硬件概要设计说明书
结构概要设计说明书
软件详细设计说明书
单元测试计划书
单元测试用例
单元测试报告
实现
产品集成计划
集成测试计划书
接口说明书
集成测试用例
集成测试报告
系统测试计划书
验证
系统测试用例
产品缺陷列表
5 文档规范说明书
认证性测试报告
系统测试报告
验证测试报告
回归测试报告
发布
缺陷报告
用户使用文档
完成阶段
系统维护文档
项目总结报告
交付结项
系统测试报告
产品缺陷列表
项目结项表单
3.3.3 部分名
可选。部分名用一对英文符号()标注（不要用中文的括号），主要是一个项目有几个文档组成的时候，对各部分组成进行标注。比如投标文件，在项目名称及文档名称之后用部分名，部分名可以是：报价部分、技术部分、商务部分、商务技术标、开标一览表等标注不同的文档。如果一个大型项目的科研报告分成几个文档也可以把 背景资料、总体规划、详细设计、实施计划等内容分成几部分，在每个文档后面用部分名进行区分。有些项目会重点突出项目的特殊性质及阶段性，也可以用部分名进行标注，比如 试点、省立项、预审文件、第一次谈判等等。
3.3.4 日期
日期：yyyymmdd， yyyy:用四位数字表示公元年份，如2018表示公元2018年。mm：用两位数字表示月份，不足两位时，第一位用零补齐，如03表示3月。dd: 用两位数字表示日期，不足两位时，第一位用零补齐，如15表示第15号。例如：20180901 表示2018年09月01日。
日期一般是提交文档的日期。
6 文档规范说明书
3.3.5 版本号
版本号以V(大写)开头，版本号为两位数字，包括主版本号和副版本号，中间用点隔开，如V1.0,V1.2，V2.0等。
版本号
编码
V1.0
V1.1
V2.0
对于没有重大修改的文档则每次修改在副版本号数字加1；当有多人同时提交同一版本的文档时，可以在版本标识的后面加入人名或缩写来区分。比如V1.0(wax),V1.0(wj)等。
说明
文档创建版本为V1.0
修改一次副版本号增加1
评审或发布主版本号增加1
3.3.6 文档后缀
新建文档，建议使用Microsoft Office 2013及以上版本的办公软件。没有特殊要求不要使用兼容模式。兼容模式会损失一些格式。
序号
1
2
3
4
5
6
文件类型
WORD文档
EXCEL文档
PowerPoint文档
Project文档
Visio文档
PDF文档
.docx
.xlsx
.pptx
.
mpp
.vsdx
后缀
7 文档规范说明书
3.4 文档名举例
XXX学校治安视频监控系统项目建设方案_20120706_
XXX大学城校区云时代智慧校园规划设计方案_20170404_
XXX地铁运营施工调度管理系统项目投标文件(商务部分)_20170711_
XXX增值业务平台综合服务系统总体设计_20170601_
XXX国际贸易“单一窗口”项目建设方案_20170302_
XXX轨道交通运营施工管理系统采购项目投标文件(商务技术标)_20170426_
XXX地铁施工调度系统项目投标文件(技术部分)_20170528_打印版.docx
XXX建筑环境及能效监控系统结构体系研究申报文件_20151225_终稿.docx
XXX企业信息化办公系统改造招标文件_发布版.docx
8 文档规范说明书
4 文档结构规范
4.1 页面设置
所有文档除个别表格和图纸使用A3页面大小外，其余一律用A4页面大小。页面一般为纵向，如需要可将部分正文设为横向。
Word页面原则上使用软件默认设置，即：上2.54cm，下2.54cm，页眉1.5cm，页脚1.75cm，左右为3.17cm，页码统一在下方居中。为避免最后一页只是几行占一页的现象，可适当收缩行距，使文档大部分内容成为整页，但收缩行距不宜小于20磅。
4.2 封面
封面内容主要包括文档标题，公司名、日期三项内容
封面没有页眉和页脚
对于投标文件还包括正副本及技术商务标识、招标编号等，具体按照招标文件要求。
4.2.1 文档标题
文档标题：字体黑体、小初、居中
单位名或者项目名，正文+字体：黑体，一号，居中，行距：1.5倍行距
公司名称
文档规范说明书
9
文档名，正文+字体：黑体，小初，居中，行距：1.5倍行距 文档规范说明书
4.2.2 公司名
公司名：人工输入公司名+LOGO，或者直接美工图片，如有必要也可以带上公司地址。
方案一（推荐）：
公司LOGO
公司中文名，字体：华文中宋，二号，居中，行距：1.5倍行距
XXX信息技术有限公司
XXX Information Technology Co.，LTD.
公司中文名，字体：黑体，小二号，居中，行距：1.5倍
行距
方案三：
公司英文名，Times New
Roman，五号，居中，行距：1.5倍行距
XXX信息技术有限公司
XXX Information Technology Co.，LTD.
公司LOGO
地址：广州市天河区XXX栋XX楼XX房
公司地址，字体：黑体、小四号，居中，行距：1.5倍行距
公司英文名，Times
New Roman，五号，居中，行距：1.5倍行距
10 文档规范说明书
4.2.3 日期
日期：中文及阿拉伯数字都可以，宋体 小三、居中。如果是中文就全部使用中文，比如二〇一六年七月十日
日期，阿拉伯数字，字体：宋体，小二号字体，居中，行距：1.5倍行距
方案一：
方案二：
2018年7月
日期，中文，字体：宋体，小二号字体，居中，行距：1.5倍行距
二零一八年七月
方案三：
日期，中文，字体：华文行楷，小二号字体，居中，行距：1.5倍行距
二零一八年七月
4.2.4 保密等级
保密等级：对于内部文档加上保密等级。
需要保密的文档密级从高到低分为“绝密”、“机密”、“秘密”“内部公开”和“公开”五级，具体定义如下：
11 文档规范说明书
绝密：涉及公司与客户或供应商，分销商所签订相关的文档资料。仅限于公司最高管理层及各资料所涉及的经过相应管理人员授权的相关人员查阅。
机密：公司内部所相关的规章制度及技术规范，开发手册等；还有各项目开发文档、管理文档及产品等仅供相关部门高级领导以及经过授权后相关人员查阅。
秘密：需交付用户或与客户进行交流的文档与产品，可供相关项目客户查阅。
内部公开：内部不限制，公司内部可以以任何形式获得文档的信息并阅读、保存、修改后自用等等，但是不允许向外传播的文件。
公开：可以对外公开或发布的文件。
4.3 文档修订历史
文档修订历史内容建议包括：序号、版本号、修改内容、修改日期、作者（修改人）、审核人等，如下表所示，可以根据实际情况添加内容。修订页中的版本和作者要与封面的版本和编制一致。
序号
1
版本
V1.0
创建
修改内容 修改日期
2020-02-27
修改人 审核人
关于版本号说明：
文档审核之后，正式发布的第一个文档版本号为1.0；之后所有审核之后的版本按顺序（全部取整，如2.0、3.0）编排版本号。
对于没有审核的文档，从原有文档副版本号 + 0.1开始按顺序编号，可以由作者自行编号。
如果只是修改一些错误，内容没有实质性变化，版本号可以不变，只是修改日期。
12 文档规范说明书
4.4 目录
首页单独成页，不设置页码。
修订历史与目录单独成页，页码单独设置为罗马数字I,II,III,目录采用超链接直接生成（或者选中模板目录内容，点右键选“更新域”），采用宋体、小四号字。一般采用三级目录，动态更新目录，任何编号栏目修改都要及时更新。
对于大型技术方案或者投标文件有根据需要也可以采用四级目录。
4.5 页眉页脚
页眉左边为项目名称，右边为文档名称
页脚居中添加页码，页码可以是普通数字，也可以是第n页共N页，页脚字体Times New Roman，小五号字体。
4.6 标题样式
文档中的同级标题样式要一致，一般情况下最少有三级标题，多的可以有六级标题。
4.7 正文
正文一般采用宋体，小四，对于篇幅比较长的技术方案，可以调整为宋体、五号。
正文行距一般情况下1.5倍行距。段前、段后均为0行。
具体公式、图表根据需要排版。
4.8 文档属性
文档属性包括标题、主题、作者、上次修改者，单位。一般情况下这些属性可以不修改，如果特殊文档，需要隐藏这些信息的，建议修改这些信息，作者统一修改成Admin,标题修改成文档名。单位修改成科技公司。
13 文档规范说明书
5 文档正文规范（建议）
5.1 字体规范
5.1.1 正文
正文：宋体，小四号字体，内容较多情况下可以为五号字体。
字形：除特殊说明之处，字形一般为常规。
字体颜色：黑色。需要特别强调或区分的内容可采用其他颜色，但建议一篇文档中不使用超过三种字体颜色。
5.1.2 数字规范
阿拉伯数字用“Times New Roman”字体显示。
5.1.3 英文规范
英文用“Times New Roman”字体显示。
5.2 标题编号
标题编号字体及格式建议如下，左对齐
标题具有项目编号：整个标题及编号撑起了整篇文档的栏目构架，在视图－>导航窗格中应可以看清这个脉络，并且没有空行，标题连续。
所有标题段落 段前段后都是0.5行，行距1.5倍行距。
以下缩进建议：
14 文档规范说明书
一级标题 悬挂缩进 0.76厘米 - 0.90厘米
二级标题 悬挂缩进 1.02厘米 – 1.20厘米 或者 2字符
三级标题 悬挂缩进 1.27厘米 – 1.80厘米
四级标题 悬挂缩进 1.50厘米 – 2.00厘米
5.3 段落
正文中的段落一般是1.5倍行距，段前段后0行距，是否空行，紧密程度应当十分注意，不要影响整体美观。
段落一般首行缩进0.74厘米或者2个字符。第2行起顶格。
段落对齐方式：两端对齐
5.4 编号
正文内容如果有需要编码序号时，可以是手工或者自动序号编码，切勿一部分自动序号，一部分手动序号，造成排版格式的不一致。
编号包括两类，一类是项目符号。项目符号原则上与当前段落的首行缩进一致。文字大小和段落与正文一样。
第一点，悬挂缩进0.76厘米，项目编号之后，字体格式和正文一样，段落格式也是段前段后都是0行，段落行距1.5倍。段落文字左对齐。
第二点
第三点
➢ 第一项
➢ 第二项
➢ 第三项
第二类是数字编号，一般在阿拉伯数字、中文数字之后采用顿号、单括号进行编号。悬挂缩进合适，从数字开始与当前段落首行缩进一致，段落文字对齐。
15 文档规范说明书
1、 第一个问题
2、 第二个问题
3、 第三个问题
1) 编号第一
2) 编号第二
3) 编号第三
(一) 论点一，这里悬挂缩进1.01厘米，字体与正文一样，从标题开始左侧距离与当前段落或者标题对齐。段落内容的第二行字与第一行对齐。
(二) 论点二
(三) 论点三
5.5 图片格式
如果是围绕图片，根据图片大小及文字内容排版，如果是嵌入式图片，一般图片居中，多图片的文档必须被引用，放在段落的前面，例如：“如下图所示”，“如图5 所示”
图片必须添加必要的题注和编号。题注和编号位置居中，采用小四或者五号宋体加粗，图释置于图的正下方；（题注图2-1中的2表示章，1表示本章的第1个图，表格与此相同）；
图2-1 规范性文字内容
图与段的行间距为1.5倍。
5.6 表格格式
表格按实际情况摆放，一般情况下是居中摆放。列表中的字体大小为宋体五号字。列表段落行距一般是1.5倍，如果内容比较多也可以是单倍行距。
16 文档规范说明书
表头位置居中，采用小四或者五号宋体加粗，表头置于表的正上方，例如“表2-1 列表样式”，表线使用细实线（0.5磅），表标题一般采用上下居中与对齐，小四或者五号宋体；表内容根据内容可以居中也可以左对齐。
列表样式如下：
表 2-1 列表样式
序号
列表第一行为标题栏，底纹是“灰色-15%”，字体是宋体加粗小四或者五号字
其他行中的汉字字体是宋体小四或者五号字，无底
纹
行距是1.5倍行距
备注
1
2
17
发布评论