文档编写规范摘要：文档编写规范一、文档分类1、业务文档各种线上业务架构说明，特定的工作说明文档，各种规章
制度
关于办公室下班关闭电源制度矿山事故隐患举报和奖励制度制度下载人事管理制度doc盘点制度下载
，规范文档等。如：工作手册、首页等网站架构文档、BBS网站架构文档、web接口程序架构文档、Puppet配置文档、数据库刻盘备份实现说明文档等2、项目文档各种项目文档，或特定软件硬件原理，使用说明等。如：Puppet语法说明、Puppet基础文档、Func基础文档、Func模块说明文档，各种脚本的使用说明等。3、操作文档各种操作文档，日常工作详细的操作说明文档如：日常操作命令参考文档、机房备份检查文档、值班工作文档、不同应用服务器软件环境配置文档。各种服务安装部署文档(LVS、nginx、apache、cacti、bb、puppet、func等)4、流程文档各种工作流程文档。二、文档撰写规范1、总则文档是运维部门的内部工作资料，是运维部门正常工作的重要支柱。因此运维文档的写作必须遵循详细、真实和全面的原则。2、文档构成2.1、目录超过5页的文档需要有目录2.2、摘要简要描述本篇文档的基本
内容
财务内部控制制度的内容财务内部控制制度的内容人员招聘与配置的内容项目成本控制的内容消防安全演练内容
,以便使用者对文档有一个清晰概括了解，便于阅读和使用。2.3、文档正文2.3.1、正文编列正文中层次不宜过多，编列格式可以按章、节、小节、条、目为准不要超出。编列标
题
快递公司问题件快递公司问题件货款处理关于圆的周长面积重点题型关于解方程组的题及答案关于南海问题
不应包含标题，由词组或短语组成，要简短明确。2.3.2、编号统一按下列
规则
编码规则下载淘宝规则下载天猫规则下载麻将竞赛规则pdf麻将竞赛规则pdf
以顿号结尾章一、节1、小节1.1、条1.1.1、目1.1.1.1、2.3.3、递进规则文中层次段落缩进要求遵守层层递进的原则，要习惯用准确的顺序编号和段落缩进来体现层次关系，同层次段落缩进要统一。2.3.4、操作步骤编号尽量统一使用(1)(2)…或a、b…2.3.5、图表插入的图表下方应有图题。图1、图1.2、等编号可参考章节编号。图标大小以不超过页面50%为宜。特殊情况可适当扩大，尽量不要占满整页。2.4、文档信息版本、日期和作者2.5、附录2.5.1、包括：参考资料、
注意事项
软件开发合同注意事项软件销售合同注意事项电梯维保合同注意事项软件销售合同注意事项员工离职注意事项
、名词解释、和其他相关的资料。2.5.2、附录内容应该与文档正文相关，并在正文中有引用。格式要求与正文一致。3、版本更新规则3.1、单次修改不超过文档总行数10%，版本号加0.01~0.09。3.2、单次修改超过文档总行数10%，版本号加0.10~0.99。3.3、累积版本号超过1的。记为新文档将旧文档归档另存。三、文档写作格式1、文件格式所有文档统一使用word排版，2、页面设置如下：纸型为：A4页边距规格为：word默认字体：宋体3.1、主标题二号黑体加粗，居中。1.5倍行距。3.2、一级标题三号黑体加粗，1.5倍行距。3.3、二级标题五号宋体加粗，1倍行距3.4、三级以下标题五号宋体，1倍行距3.3、正文五号宋体，1倍行距版本：V0.8撰写人：马彦杰日期：2010-11-22
浙公网安备 33021202002483