8.2 信息架构原则
信息架构决定了文档内容的组织方式和导航结构,良好的信息架构能帮助读者快速定位所需信息。
R-143
推荐
信息组织应从概述到细节
技术文档的内容组织应遵循「先总后分」的原则。每个章节应先提供概述性信息,帮助读者建立整体认知,然后再展开具体细节。这种渐进式的信息呈现方式符合读者的认知规律,能够有效降低信息理解难度。
R-144
推荐
相关内容应集中组织
逻辑上相关的内容应尽量放在同一章节或相邻位置,避免读者在文档中来回翻阅。如果相关内容确实需要分散在不同章节,应通过交叉引用链接进行关联。信息分散是导致文档可用性低下的常见原因之一。
正确
目录结构: 1. 产品概述 2. 安装与配置 2.1 系统要求 2.2 安装步骤 2.3 初始配置 3. 基本操作 3.1 创建项目 3.2 编辑内容 3.3 发布内容
错误
目录结构: 1. 产品概述 2. 创建项目 3. 系统要求 4. 初始配置 5. 编辑内容 6. 安装步骤 7. 发布内容
正确示例按照使用流程和逻辑关系组织内容,安装相关信息集中在一个章节,操作相关信息集中在另一个章节。错误示例将相关内容打散排列,读者无法按流程顺序阅读。
R-145
推荐
导航路径不应超过三层
文档的导航层级不宜过深,建议控制在三层以内(如「章 > 节 > 小节」)。过深的层级会增加读者的导航成本,降低信息的可发现性。如果某个节点下的子项过多,应考虑重新组织信息结构。
技巧
可以使用「卡片分类法」对信息架构进行测试:将文档的各个主题写在卡片上,邀请目标读者按照自己的理解进行分组和排序。这种方法能够帮助发现信息组织中不符合用户心理模型的问题,从而优化文档结构。