制定知识文档结构规范，关键是把“写什么、按什么顺序写、写到什么程度”变成团队可执行的共同约定。做法是先按用途给文档分类，再为每类定义章节层级和必备要素，落成模板与检查清单。本文按这四个步骤展开，并说明如何借助ONES Wiki的模板库、页面树和版本记录承载规范。
要点总览（TL;DR）
- 先按用途把知识文档分成四到六类，再为每类定义章节层级上限、编号方式和标题写法，避免一套结构套所有文档。
- 必备要素按文档类别分别列出，必填与选填用统一标记区分，缺失必备章节即判定文档不完整。
- 把层级和要素落成可复制的模板，每个章节配填写说明和内容粒度建议，模板标注版本号与维护责任人。
- 设置规范制定者、文档作者、评审者、规范维护者四类角色，明确各自交付物，规范才能持续执行。
- 发布前用同一份检查清单做作者自检、同行评审和定期抽样复核，不通过退回修改，规范本身按季度复核修订。
先定规范骨架：文档分类、章节层级与必备要素
结构规范从文档分类开始。团队里的知识文档用途差异很大，用一套章节要求覆盖所有文档，结果往往是操作指南被塞进背景论述，复盘记录缺少结论。按用途分类后，每类文档的读者、阅读场景和关键信息不同，层级和要素才能定得具体。
建议先盘点近半年实际产出的文档，按用途归并成四到六类。常见分类如下表，团队可增删，但类别数量不宜过多，否则维护成本会超过收益。
| 文档类别 | 典型读者 | 核心阅读目的 | 建议层级深度 |
|---|---|---|---|
| 操作指南 | 执行同一任务的新成员 | 照着步骤完成操作 | 三级：章—步骤组—具体步骤 |
| 方案说明 | 评审者、下游协作方 | 理解背景、方案取舍与影响 | 三级：章—节—条目 |
| 复盘记录 | 团队管理者、后续项目成员 | 了解事实、原因与改进动作 | 两级：章—节 |
| 接口说明 | 调用方开发人员 | 查参数、返回值与异常 | 三级：章—接口—字段 |
层级规则要写死三件事。第一是最大层级数，多数知识文档控制在三级以内即可，超过三级说明内容需要拆分或改用表格承载。第二是编号方式，全团队统一采用“1 / 1.1 / 1.1.1”这类数字编号，或统一不用编号只靠标题层级，两种方式不要混用。第三是标题写法，规定标题描述内容而非描述动作，例如“前置条件”优于“说一下需要准备什么”，同类文档的同一章节使用相同标题，便于检索和比对。
必备要素按文档类别分别列出。以操作指南为例，必备要素包括目的、适用范围、前置条件、操作步骤、结果与验证、变更记录；方案说明的必备要素则是背景与问题、目标与范围、方案内容、影响与风险、结论。可选要素单独成列，例如操作指南中的“常见问题”“相关文档”，作者按实际情况决定是否添加。必备要素缺失即判定文档不完整，可选要素缺失不影响通过。这一步的交付物是一份文档分类表，每类文档对应一行层级规则和一张必备要素清单。
把规范落成模板：字段说明与填写示例
规则写在制度文档里，作者写作时未必会翻。把每类文档的层级和要素做成可复制的模板，规范才真正进入日常写作。模板包含三部分：固定的章节骨架、每个章节的填写说明、必填与选填的标注。
填写说明要给出内容粒度，而不只是章节名称。例如“前置条件”一栏注明“列出执行前必须已具备的账号、权限、数据或环境，逐条写，每条一句话”；“操作步骤”注明“一步一个动作，包含操作对象和预期界面反馈，单步不超过三行，涉及判断分支时单独成节”。字数建议按章节给区间而非精确值，避免作者为凑字数填充无关内容。
必填与选填用统一标记区分，常见做法是在章节标题后加“（必填）”或“（选填）”，并在模板开头用一句话说明标记含义。标记方式一旦确定，所有类别模板保持一致，评审者据此快速判断完整性。
下面是一段已填写的操作指南示例，展示层级与要素如何对应：
| 层级 | 章节标题 | 填写内容示例 |
|---|---|---|
| 1 | 目的（必填） | 说明成员如何在新项目中开通测试环境账号。 |
| 1.1 | 适用范围（必填） | 适用于研发中心各项目组，不覆盖外部合作方账号。 |
| 1.2 | 前置条件（必填） | 已加入对应项目；已获得环境管理员审批。 |
| 2 | 操作步骤（必填） | 2.1 登录管理后台，进入“环境管理”；2.2 选择目标项目，点击“申请账号”…… |
| 3 | 结果与验证（必填） | 收到开通邮件后，用新账号登录测试环境，能看到项目首页即视为成功。 |
| 4 | 变更记录（必填） | 记录版本号、修改人、修改日期与修改要点。 |
模板本身也要管理。每个模板标注版本号和维护责任人，版本号随规范修订递增，旧版本归档保留。作者使用模板时从最新版本复制，避免不同时期创建的文档结构不一致。ONES Wiki 的页面模板库支持一键创建制式化文档模板，可作为模板分发的载体；具体配置方式以实际版本为准。
角色分工与交付物：谁写、谁审、谁维护规范
规范能否执行，取决于每个环节是否有人负责、有明确产出。建议设置四类角色，职责和交付物如下表。
| 角色 | 主要职责 | 交付物 |
|---|---|---|
| 规范制定者（知识管理负责人或文档负责人） | 组织分类盘点，定义层级规则与必备要素，发布规范与模板 | 文档分类表、层级规则、必备要素清单、模板及填写说明 |
| 文档作者 | 按对应类别模板撰写，发布前完成自检 | 符合规范的文档、自检记录 |
| 评审者（同行或领域负责人） | 按检查清单核对结构完整性与内容准确性 | 评审意见与评审结论 |
| 规范维护者 | 收集执行中的问题，按触发条件修订规范与模板 | 修订记录、新版规范与模板 |
规范制定者通常由知识管理负责人承担，在团队规模较小时也可由文档负责人兼任。其核心产出不是一份制度文本，而是分类表、要素清单和模板三件可直接使用的材料。文档作者的责任是按类别选用正确模板，不自行增删必备章节；确有必要调整结构时，先向规范维护者提出，而不是在单篇文档里另起一套写法。
评审者的检查以清单为准，评审记录至少包含检查日期、检查项结果和不通过原因。规范维护者的修订由三类情况触发：业务或工具发生变化导致原有章节失效；抽样复核中同类问题反复出现；模板在实际使用中被证明过于繁琐。修订节奏可按季度例行复核，触发条件出现时随时修订。每次修订保留修订记录，写明改了哪条规则、为什么改、从哪个版本生效。
规范落地后，模板分发、评审意见和版本留痕需要有承载位置。ONES Wiki 支持页面树组织文档，可将不同类别的模板与成文文档分层存放；文档记录所有页面版本并支持查看与回滚，评审意见可通过页面评论留存。这些能力承担的是规范执行中的协作动作，规则本身仍需团队自行定义。
一致性检查规则与完成检查清单
规范发布后，一致性靠检查维持。检查分三层：作者发布前自检、同行评审把关、知识管理负责人定期抽样复核。三层使用同一份检查清单，只是执行人和覆盖范围不同。
发布前检查项建议包含以下内容，每项给出可判定的标准：
- 必备章节齐全：对照所属类别的必备要素清单逐项核对，缺一项即不通过。
- 层级不越级：从一级章到二级节逐层展开，不出现一级章下直接跳三级条目的情况；层级数量不超过该类文档规定的上限。
- 要素字段已填：前置条件、结果与验证等章节有实质内容，仅写“无”“待补充”视为未填写。
- 示例与术语一致：同一概念在全文中使用同一名称，操作步骤中的界面名称与实际系统一致。
- 变更记录完整：记录版本号、修改人、修改日期与修改要点。
检查方式上，作者自检在提交评审前完成，可用清单逐项打勾；同行评审由熟悉该领域的成员执行，重点核对内容准确性与结构完整性，评审意见写入文档评论或评审记录；抽样复核由知识管理负责人按固定比例抽取已发布文档，例如每季度抽取每类文档若干篇，统计不通过项分布，作为规范修订的依据。
检查不通过时，退回作者修改并重新提交，评审记录中保留退回原因。同一文档连续两次因同一检查项退回，应反馈给规范维护者，判断是模板说明不清还是作者理解偏差。规范本身的复核按季度进行，复核内容包括检查清单的适用性、模板的使用频率和常见退回原因；每次修订更新版本号并写入修订记录，确保作者使用的是当前有效版本。
完成判定标准可以概括为：文档所属类别明确、必备章节无缺失、层级符合该类上限且无越级、必填要素有实质内容、变更记录可追溯。五项全部满足即通过，任一项不满足则退回。把这套清单与模板一起发布，团队就有了从写作到发布的一致口径。
常见问题
团队文档数量不多，也需要先分类再定层级吗？
需要，但分类可以更粗。文档数量少时，按用途归并成三到四类即可，例如操作指南、方案说明、复盘记录。分类的目的是让每类文档有明确的读者和阅读场景，层级和必备要素才能定得具体。如果跳过分类直接定一套通用章节，容易出现操作指南被要求写背景论述、复盘记录缺少结论的情况。分类数量以维护成本不超过收益为限，后续文档类型增加时再拆分。
章节层级控制在三级以内，遇到复杂内容怎么处理？
三级以内是多数知识文档的适用上限，不是硬性禁止。遇到内容确实复杂的情况，优先考虑拆分文档或改用表格承载，而不是继续加深层级。例如操作指南中涉及多个判断分支时，可以把每个分支单独成节，或拆成多篇文档并用相关文档链接关联。如果团队确实需要四级层级，应在规范中为该类文档单独规定上限，并同步更新检查清单中的层级判定标准，避免评审时口径不一。
必备要素清单定好后，作者提出某类文档不需要某个章节怎么办？
先区分两种情况。如果是该类文档的普遍情况，说明必备要素清单需要修订，由规范维护者评估后调整清单和模板版本，并记录修订原因。如果只是单篇文档的特殊情况，作者应按模板保留必备章节，在章节内说明不适用原因，而不是直接删除章节。评审者检查时看到章节存在且有说明，即可判定通过；章节缺失则退回。这样既保持结构一致，也允许合理例外被记录和追溯。
一致性检查由谁执行，检查频率怎么定？
检查分三层执行。作者在提交评审前按清单自检；同行评审由熟悉该领域的成员在评审环节核对；抽样复核由知识管理负责人按固定比例抽取已发布文档，例如每季度每类文档抽取若干篇。三层使用同一份检查清单，执行人和覆盖范围不同。抽样复核的频率可根据文档产出量调整，产出量大的团队可提高抽取比例或缩短复核周期。复核结果用于统计不通过项分布，作为规范修订的依据。
规范发布后，怎么让作者持续使用最新模板？
模板需要版本号和维护责任人，每次规范修订时递增版本号，旧版本归档保留。作者从最新版本复制模板，避免不同时期创建的文档结构不一致。分发上可以把模板集中存放在团队常用的文档协作工具中，例如 ONES Wiki 的页面模板库支持一键创建制式化文档模板，页面树可将不同类别的模板与成文文档分层存放，版本记录可查看和回滚页面历史。具体配置方式以实际版本为准。规范维护者定期检查模板使用情况，发现作者仍在使用旧版本时及时提醒并更新链接。
