夜雨聆风学习资料网

ARTICLE · 1396045

规范IT文档格式:从封面到附录,一套规则减少排版返工

规范IT文档格式:从封面到附录,一套规则减少排版返工

笔者平时在工作中既参与IT文档写作,也负责文档审核,经常碰到这些问题:正文格式不统一,字体字号、段落格式各行其是;表格格式不规范;题注和交叉引用缺失,图表编号靠手写;目录页码错乱;标题编号手动输入导致不连续。这些毛病看似零散,归结起来,主要是样式、自动编号、题注、交叉引用和分节等功能没有用好。那么,规范的IT文档,格式上到底该注意什么?结合平时写作和审核中反复遇到的问题,我做了梳理,分享如下。

一、总则

统一排版标准,保证文档结构完整、表述准确、方便维护。适用于立项、招投标、设计、实施、验收等各类IT材料。

基本要求:层次清晰、编号连续、术语统一;图表配套齐全;提交前清除修订记录和批注。

二、文档整体结构

固定顺序:封面→目录→正文→附录。

封面:必选,单独一页,不显示页码

目录:必选,单独起页

正文:必选,文档核心内容

附录:可选,放置配置、原始日志、参考材料等补充内容

三、页面基础设置

统一使用 A4 纸张。页边距推荐上下 2.54cm、左右 3.17cm;团队已有模板的,优先沿用模板参数。页眉宋体小五,居中放置文档名称;页脚宋体小五,放置页码。

四、页码规则

不同区域的独立页码靠分节符实现,严禁手动输入页码。

封面:无页码

目录:罗马数字Ⅰ、Ⅱ、Ⅲ……单独编号

正文:阿拉伯数字从 1 开始编号

附录:延续正文阿拉伯数字页码,连续往下排(区别目录)

操作要点:封面与目录之间、目录与正文之间插入【分节符(下一页)】;每一节的页眉页脚取消“链接到前一节”,单独设置页码格式和起始值。页码放页脚居中,全文展示格式一致。如采用“第 X 页共 Y 页”,需在每一节单独设置,并确认“共 Y 页”域更新后与实际页数一致。封面不显示页眉页脚;目录节使用罗马数字;正文及附录使用阿拉伯数字连续编号。

五、封面

封面单独一页,不加页眉、不编页码,只放基础信息:文档标题、文档编号、版本号、编制单位、编制日期、密级(按需)。标题建议黑体二号或小初居中;其余信息宋体、字号统一。封面不放正文和图表。

六、目录

放在封面之后、正文之前,单独另起一页。目录基于标题样式自动生成,不要手动录入,默认显示至三级标题。“目录”二字黑体四号居中;条目宋体小四、1.5 倍行距,左对齐,页码右对齐,中间用省略前导符连接。目录包含正文各级标题与附录标题;图表目录按需增加,放在普通目录之后。

七、正文格式

1. 标题层级

共五级标题,全部黑体、左对齐、单倍行距。编号用多级列表自动生成,禁止手打;编号与文字之间空一格。

一级标题:编号 1,四号

二级标题:编号 1.1,四号

三级标题:编号 1.1.1,小四

四级标题:编号 1.1.1.1,小四

五级标题:编号 1.1.1.1.1,五号

编号通过多级列表与样式绑定,回车自动沿用上一级编号。五级用于最细颗粒度条款;层级更深时改用列表,不再增加标题级别。

2. 正文段落

宋体小四,固定值 22 磅行距,首行缩进 2 字符,两端对齐,段前段后 0 磅。

3. 列表

有序列表用自动编号,编号与文字悬挂对齐;无序列表用项目符号,缩进 2 字符,同级句式一致。长内容换行采用悬挂缩进,回行文字与正文对齐。

4. 术语、代码、注释

专业术语首次出现可加粗,全文表述统一,同一概念只用一种说法,避免混用“接口/界面”“校验/验证”等;代码、命令行使用 Consolas 等等宽字体,10pt、单倍行距、段前段后各 6 磅,加浅灰底纹与正文区分;注释、引用用宋体五号,可斜体;引用规范条文、外部标准原文时注明出处。

5. 表格

表内文字宋体五号、单倍行距、内容居中;表头加粗,可加浅灰底纹。表题放在表格上方居中,宋体五号,段前 12 磅、段后 6 磅。表格编号用题注自动生成,如采用“表 X.Y-Z”;跨页续页重复表头并标注“续表”,单行不跨页拆分;空白单元格填“—”。正文提到表格时使用交叉引用。

6. 插图

图题放在图片下方居中,宋体五号,段前 6 磅、段后 12 磅。图编号用题注自动生成,如采用“图 X.Y-Z”。正文提到图表时用交叉引用插入,如“如图 X.Y-Z 所示”,不要手写编号。图表统一按节编号;附录内图表单独编号,如图 A1、表 B1。

八、附录

附录放在正文之后,单独起页,编号依次为附录 A、附录 B。格式、正文样式、图表规则与正文一致;附录内图表单独编号,不占用正文标题序号。正文应主动引用对应附录。附录页码跟随正文连续编号。术语表建议列“术语、英文/缩略语、说明”三列,无内容填“—”;正文首次出现的专业术语应与附录术语表保持一致。

九、文档命名规则

格式:项目简称_文档类型_版本号_日期.docx

示例:智慧平台_需求规格说明书_V1.0_20261121.docx

版本为 V 主版本.次版本;日期用 YYYYMMDD。

十、提交前检查要点

按顺序自查:正文样式是否统一,字体、字号、段落格式是否与模板一致;表格格式是否规范;图表编号是否由题注生成,正文是否使用交叉引用;标题编号是否由多级列表自动生成,有无手动输入;目录是否更新,目录页码是否为罗马数字,正文及附录页码是否为阿拉伯数字;页码是否由分节符实现,各节页眉页脚是否取消“链接到前一节”;修订模式是否关闭,批注与隐藏文字是否删除;全文数字与单位写法是否统一等。

✍小贴士

把握三条核心原则:

✅标题、图表编号全部用自动功能生成

✅不同区域页码靠分节符分开设置

✅图表使用题注 + 交叉引用

前期花几分钟调好样式和分节,后续新增、删减内容只需刷新域,无需全文逐个修改序号,返工量会大幅减少。

配套模板下载:

本文整理了配套模板。关注公众号,私信“技术文档格式模板”,即可获取。

回首页,搜索你想要的文档

在首页搜索框输入关键词,快速定位资料

文库首页搜索指引 立即搜索

相关学习资料