01
文档规范概述
文档的重要性 · 规范定义 · 目标与价值 · 常见类型简介
基础概念
02
文档生命周期
创建 · 审核 · 发布 · 维护 · 归档与废止流程
流程管理
03
文档角色与职责
作者 · 审校者 · 审批者 · 发布者 · 维护者
角色RACI
04
文档命名规范
文件命名规则 · 版本号命名 · 日期格式规范
命名版本
05
文档目录结构
标准目录层级 · 文件夹组织 · 索引文件作用
结构组织
06
文档模板结构
封面 · 修订记录 · 目录 · 正文 · 附录 · 封底
模板标准
07
封面与标题页设计
标题 · 副标题 · 文档编号 · 版本 · 日期 · 密级 · 作者
封面元数据
08
修订记录规范
版本号 · 修订日期 · 修订人 · 内容摘要 · 审核人
历史追溯
09
目录生成规范
自动目录要求 · 层级限制 · 图表目录与表格目录
目录导航
10
正文排版规范
字体 · 字号 · 行距 · 段落间距 · 对齐 · 页边距
排版可读性
11
标题层级规范
一级/二级/三级标题编号规则与样式
标题层级
12
段落与文本规范
段落结构 · 强调方式 · 引用 · 有序/无序列表
文本列表
13
表格规范
表格标题 · 表头样式 · 对齐 · 跨页处理 · 编号
表格数据
14
图片与插图规范
图片格式 · 分辨率 · 图注 · 编号 · 引用方式
图片视觉
15
代码与命令规范
代码块格式 · 行号 · 语法高亮 · 命令与输出区分
代码技术
16
术语与缩写规范
术语表建立 · 首次定义 · 缩写全称标注
术语一致性
17
交叉引用规范
章节引用 · 图表引用 · 表格引用 · 公式引用
引用链接
18
脚注与尾注规范
使用场景 · 格式 · 编号规则
注释补充
19
附录规范
附录分类 · 附录编号 · 内容要求
附录补充
20
参考文献规范
引用格式 (GB/T 7714) · 参考文献列表排列规则
引用学术
21
文档模板设计原则
一致性 · 可复用性 · 可扩展性 · 易用性
设计原则
22
Word文档模板制作
样式设置 · 页眉页脚 · 自动编号 · 域代码 · 模板保存
Word实操
23
Markdown文档规范
语法规范 · YAML头信息 · 代码块 · 图片链接
Markdown轻量
24
LaTeX文档规范
文档类选择 · 宏包使用 · 编译流程 · 模板示例
LaTeX排版
25
API文档规范
RESTful结构 · 请求/响应示例 · 错误码说明
API开发
26
用户手册规范
目标用户分析 · 操作步骤编写 · 故障排除指南
手册UX
27
技术白皮书规范
背景介绍 · 技术架构 · 核心特性 · 性能数据
白皮书技术
28
文档质量评审
评审流程 · 检查清单 · 常见问题与改进
质量评审
29
文档版本控制
Git与文档管理 · 分支策略 · 版本发布标签
Git版本
30
文档自动化工具
Sphinx · MkDocs · Docusaurus · Read the Docs 选型
自动化工具