第3章 文档结构设计
📐 文档大纲规划 · 章节层级设计 · 信息架构(IA)基础
文档结构是技术写作的骨架。优秀的结构让读者快速定位信息,降低认知负荷。本章从大纲规划、层级设计到信息架构,系统讲解如何搭建清晰、可扩展的文档体系。
1. 文档大纲规划
大纲是文档的“蓝图”。在动笔之前,先定义核心主题、目标读者和关键任务。推荐使用 主题分组法 与 任务流法 结合。
📌 大纲规划三步法
- 受众分析:读者角色、知识水平、使用场景。
- 内容拆解:将主题分解为 5~9 个主要模块。
- 优先级排序:按使用频率或逻辑顺序排列。
2. 章节层级设计
层级设计遵循“3 层原则”:章节(Chapter)→ 主题(Topic)→ 子主题(Sub-topic)。避免超过 4 层,防止迷失。
| 层级 | 示例 | 说明 |
|---|---|---|
| 第1层 (H1) | 3. 文档结构设计 | 章标题,独立主题 |
| 第2层 (H2) | 3.1 文档大纲规划 | 节标题,核心模块 |
| 第3层 (H3) | 3.1.1 受众分析 | 子主题,具体内容 |
| 第4层 (H4) | 3.1.1.1 角色定义 | 极少使用,可改用列表 |
3. 信息架构(IA)基础
信息架构关注组织、导航与标签。核心模型包括:层级结构、矩阵结构、线性结构。文档中常用混合模型。
🔷 IA 三支柱
- 组织系统:按主题、任务或用户群体分类。
- 导航系统:全局导航、局部导航、面包屑、索引。
- 标签系统:清晰、一致的术语,避免歧义。
4. 实战:结构设计检查表
使用以下清单评估文档结构完整性:
- ✅ 是否包含目标读者与前置条件?
- ✅ 章节标题是否反映内容核心?
- ✅ 层级深度是否 ≤ 3 层?
- ✅ 是否存在“其他”或“杂项”章节?
- ✅ 导航元素(目录、面包屑)是否清晰?
# 3. 文档结构设计
## 3.1 文档大纲规划
### 3.1.1 受众分析
### 3.1.2 内容拆解
## 3.2 章节层级设计
### 3.2.1 三层原则
## 3.3 信息架构基础
### 3.3.1 组织系统
### 3.3.2 导航系统
### 3.3.3 标签系统