文档编写规范
综合能力考核表详细内容
文档编写规范
为编写各类技术文档提供指导,以达到整齐、风格统一的效果,对文档的格式、命名、版面、文字等进行了规范,以供参考。
2、 范围
适合于Microsoft Word类文档,但编号规则适用于全部项目和模版文档。
3、 文档首页(封面)
<页首>公司徽记[图标,居左上角]
文档名称[黑体,二号,加粗,居中]
文档编号[宋体,四号,居中]
版本号[宋体,四号,居中]
<页尾> 作者:[宋体,四号,居中]
年 月 日[宋体,四号,居中]
公司名称[宋体,四号,居中]
命名规则:当前版本没有设置专门的规则,只是用中文命名,这个文件名表达了编写该文档的意图,后缀为相应文档编辑软件的扩展名。
编号规则:Q/RKS -<ID>-<TYPE>-<SNO>
<Q/RKS> 公司代码
< ID > 英文缩写
1)SP 软件过程模板类
2)YYXXX 项目工作产品类
YYXXX表示项目代码,五位:YY:为年号 XXX:为序号
<TYPE> 文档类别,英文缩写。
例子: GNR 通用类文档
RM 需求类文档(包括验收计划)
SPP 项目计划类文档(包括各种测试计划)
SPT 计划跟踪和监控类文档
SQA 质量保证类文档
SCM 配置管理类文档
PR 评审类文档
COM 沟通类文档
DES 设计类文档
TRN 培训类文档
EST 项目估算类文档
TEC 技术标准类文档
DEV 开发规范类文档
MTN 维护类文档
DB 数据库DDL脚本类文档
QC 测试类文档
<SNO> 文件按时间产生的顺序号,范围01-99。
例子: Q/RKS-SP-GNR -09 -> 文档书写规范
版本编号:初始的版本号为1.0,为适应某一方面的要求进行的升级为点版本升级,如1.1、1.2等,全面的设计更改或大的变更,升级为2.0、3.0等。
说明:在项目中使用各种模版时,模版中出现的软件过程模版类编号一律改为项目工作产品类编号,如软件需求说明书页脚的Q/RKS-SP-RM-05改为Q/RKS-YYXXX-RM-SNO。
4、 页眉与页脚
(1)、原则:页面属性[版式]配置为首页不同,即首页之后的页面均采用本节规定的格式,[文档网格]配置为无网格。
(2)、页眉: 文档名称 [宋体,五,左齐] 版本号:[宋体,五,居中] 公司徽记[图标,右齐]
自动加下划线
例子:
软件需求说明书 版本号:1.0
(3)、页脚:
文档ID[宋体,小五,左齐]年 月 日[宋体,小五,居中]Page of [宋体,小五,右齐]
例子:
Q/RKS-SP-RM-05 2001年8月15号 Page 1 of 5
说明:在项目使用时,其中版本号为项目文档的版本号,日期为项目文档的编写时间。
5、 文档控制和签字确认
有首页(封面)的放在第二页,即目录页前一页;无封面放在最后一节。
例子:
文档修订
版本 日期 修改人 描述(注明修改的条款或页)
批准人签字
职务 甲方/乙方 姓名 日期
6、 目录
比较大的文档可设置目录页,配置为显示页码和页码右对齐,直接插入即可,单独成为一页。此页加正文“目录” [黑体,二号,加粗,居中]。显示级别为3,格式选模板中“正式”,字体四号。
7、 正文(含附录)
字体:中文宋体小四,不加粗;
标题1:黑体,三号,加粗(Microsoft word2000缺省);如:“1.”
标题2:黑体,四号,加粗(Microsoft word2000缺省); 如:“1.1”
标题3:黑体,小四号,加粗(Microsoft word2000缺省), 如:“1.1.1”
编号控制在4级之内。
行间距:单倍行间距。
段落出现两行以上的首行缩进二个汉字,段落间可加一空行。
8、 过程文件中各项内容编排的一般顺序
文档编写规范
为编写各类技术文档提供指导,以达到整齐、风格统一的效果,对文档的格式、命名、版面、文字等进行了规范,以供参考。
2、 范围
适合于Microsoft Word类文档,但编号规则适用于全部项目和模版文档。
3、 文档首页(封面)
<页首>公司徽记[图标,居左上角]
文档名称[黑体,二号,加粗,居中]
文档编号[宋体,四号,居中]
版本号[宋体,四号,居中]
<页尾> 作者:[宋体,四号,居中]
年 月 日[宋体,四号,居中]
公司名称[宋体,四号,居中]
命名规则:当前版本没有设置专门的规则,只是用中文命名,这个文件名表达了编写该文档的意图,后缀为相应文档编辑软件的扩展名。
编号规则:Q/RKS -<ID>-<TYPE>-<SNO>
<Q/RKS> 公司代码
< ID > 英文缩写
1)SP 软件过程模板类
2)YYXXX 项目工作产品类
YYXXX表示项目代码,五位:YY:为年号 XXX:为序号
<TYPE> 文档类别,英文缩写。
例子: GNR 通用类文档
RM 需求类文档(包括验收计划)
SPP 项目计划类文档(包括各种测试计划)
SPT 计划跟踪和监控类文档
SQA 质量保证类文档
SCM 配置管理类文档
PR 评审类文档
COM 沟通类文档
DES 设计类文档
TRN 培训类文档
EST 项目估算类文档
TEC 技术标准类文档
DEV 开发规范类文档
MTN 维护类文档
DB 数据库DDL脚本类文档
QC 测试类文档
<SNO> 文件按时间产生的顺序号,范围01-99。
例子: Q/RKS-SP-GNR -09 -> 文档书写规范
版本编号:初始的版本号为1.0,为适应某一方面的要求进行的升级为点版本升级,如1.1、1.2等,全面的设计更改或大的变更,升级为2.0、3.0等。
说明:在项目中使用各种模版时,模版中出现的软件过程模版类编号一律改为项目工作产品类编号,如软件需求说明书页脚的Q/RKS-SP-RM-05改为Q/RKS-YYXXX-RM-SNO。
4、 页眉与页脚
(1)、原则:页面属性[版式]配置为首页不同,即首页之后的页面均采用本节规定的格式,[文档网格]配置为无网格。
(2)、页眉: 文档名称 [宋体,五,左齐] 版本号:[宋体,五,居中] 公司徽记[图标,右齐]
自动加下划线
例子:
软件需求说明书 版本号:1.0
(3)、页脚:
文档ID[宋体,小五,左齐]年 月 日[宋体,小五,居中]Page of [宋体,小五,右齐]
例子:
Q/RKS-SP-RM-05 2001年8月15号 Page 1 of 5
说明:在项目使用时,其中版本号为项目文档的版本号,日期为项目文档的编写时间。
5、 文档控制和签字确认
有首页(封面)的放在第二页,即目录页前一页;无封面放在最后一节。
例子:
文档修订
版本 日期 修改人 描述(注明修改的条款或页)
批准人签字
职务 甲方/乙方 姓名 日期
6、 目录
比较大的文档可设置目录页,配置为显示页码和页码右对齐,直接插入即可,单独成为一页。此页加正文“目录” [黑体,二号,加粗,居中]。显示级别为3,格式选模板中“正式”,字体四号。
7、 正文(含附录)
字体:中文宋体小四,不加粗;
标题1:黑体,三号,加粗(Microsoft word2000缺省);如:“1.”
标题2:黑体,四号,加粗(Microsoft word2000缺省); 如:“1.1”
标题3:黑体,小四号,加粗(Microsoft word2000缺省), 如:“1.1.1”
编号控制在4级之内。
行间距:单倍行间距。
段落出现两行以上的首行缩进二个汉字,段落间可加一空行。
8、 过程文件中各项内容编排的一般顺序
文档编写规范
[下载声明]
1.本站的所有资料均为资料作者提供和网友推荐收集整理而来,仅供学习和研究交流使用。如有侵犯到您版权的,请来电指出,本站将立即改正。电话:010-82593357。
2、访问管理资源网的用户必须明白,本站对提供下载的学习资料等不拥有任何权利,版权归该下载资源的合法拥有者所有。
3、本站保证站内提供的所有可下载资源都是按“原样”提供,本站未做过任何改动;但本网站不保证本站提供的下载资源的准确性、安全性和完整性;同时本网站也不承担用户因使用这些下载资源对自己和他人造成任何形式的损失或伤害。
4、未经本网站的明确许可,任何人不得大量链接本站下载资源;不得复制或仿造本网站。本网站对其自行开发的或和他人共同开发的所有内容、技术手段和服务拥有全部知识产权,任何人不得侵害或破坏,也不得擅自使用。
我要上传资料,请点我!
管理工具分类
ISO认证课程讲义管理表格合同大全法规条例营销资料方案报告说明标准管理战略商业计划书市场分析战略经营策划方案培训讲义企业上市采购物流电子商务质量管理企业名录生产管理金融知识电子书客户管理企业文化报告论文项目管理财务资料固定资产人力资源管理制度工作分析绩效考核资料面试招聘人才测评岗位管理职业规划KPI绩效指标劳资关系薪酬激励人力资源案例人事表格考勤管理人事制度薪资表格薪资制度招聘面试表格岗位分析员工管理薪酬管理绩效管理入职指引薪酬设计绩效管理绩效管理培训绩效管理方案平衡计分卡绩效评估绩效考核表格人力资源规划安全管理制度经营管理制度组织机构管理办公总务管理财务管理制度质量管理制度会计管理制度代理连锁制度销售管理制度仓库管理制度CI管理制度广告策划制度工程管理制度采购管理制度生产管理制度进出口制度考勤管理制度人事管理制度员工福利制度咨询诊断制度信息管理制度员工培训制度办公室制度人力资源管理企业培训绩效考核其它
精品推荐
下载排行
- 1社会保障基础知识(ppt) 16695
- 2安全生产事故案例分析(ppt 16695
- 3行政专员岗位职责 16695
- 4品管部岗位职责与任职要求 16695
- 5员工守则 16695
- 6软件验收报告 16695
- 7问卷调查表(范例) 16695
- 8工资发放明细表 16695
- 9文件签收单 16695
- 10跟我学礼仪 16695