A7.15.5Layered documentation设计

不同层次的说明文档应分别针对不同熟练程度的用户

别名: 分层文档 · progressive disclosure documentation · 渐进式文档

概念解释

系统模型天然分功能、结构、实现三层,不同用户需要停留的层级也不同,说明文档不应该是单一一份、面向"平均用户"的内容,而应该按层级分别组织:让新手只读到功能层的说明,需要规划复杂任务的用户能查到结构层的说明,需要深入的用户(开发者、高级用户)能查到实现层说明,各自不必读到自己不需要的层级。

机制

单一文档为了"照顾所有人",往往被迫把三层信息混在同一段落里:新手在功能说明中间读到实现层术语,会被迫中断阅读去理解与自己无关的信息;进阶用户想找结构或实现层细节,又要在大量功能层的基础介绍里翻找,两类需求彼此拖累对方的阅读效率。按层级分别组织文档,等于让文档的信息颗粒度与读者当前所处的模型层级对齐:读者只需要在自己已经具备的层级基础上做增量学习,而不必每次都从功能层从头读起。

边界

  • 这个原则要求先能准确判断用户当前所处的层级;如果产品面向的用户群体本身层级差异很小(比如高度同质化的专业工具,用户清一色是同一角色),分层文档带来的收益有限,维护多份文档的成本可能大于收益。
  • 层级不是一次性判定的:同一个用户在使用产品早期只需要功能层文档,随着熟练度提升会主动寻求结构层甚至实现层内容,文档结构需要支持这种渐进查阅,而不能假设用户永远停在入门时被分配的那个层级。

怎么落地

  • 文档信息架构按功能层(能做什么,入门向)、结构层(怎么组合完成复杂任务,进阶向)、实现层(内部机制,专家/开发者向)分别设立独立入口,允许交叉链接,但不强制读者按顺序穿过三层。
  • 每篇功能层文档结尾提供"想了解更多"式的跳转,指向对应任务的结构层文档,而不是把结构信息硬塞进功能说明正文里,增加新手的阅读负担。
  • 验证办法:抽样统计不同文档层级页面的用户来源与跳出行为,如果新手频繁从功能层文档跳到实现层页面又迅速返回,说明当前的功能层文档本身混入了不必要的实现层信息,把用户"推"出了他本该停留的层级。

延伸

  • 同组A7.15.1 功能层描述系统能做什么,与用户目标直接对应 · A7.15.2 结构层描述功能之间如何组织与关联,是完成复杂任务的路径依据 · A7.15.3 实现层描述底层具体机制,多数用户不需要也不应被要求理解 · A7.15.4 界面暴露实现层细节而遗漏结构层,会让用户知道零件却拼不出整体
  • 相邻A7.10 概念模型的显式表达
  • 站内检索layered documentation · progressive disclosure · system model levels · user proficiency

同组卡片

快捷操作

分享

分享当前页面

ios_share

https://hci.top/zh/handbook/A7.15.5