从了解用户和产品开始
与利益相关者建立基础
- 解释产品如何运作的最简单方式是什么?
- 产品的核心构建模块是什么?
- 用户通常如何采用该产品?他们最常在哪里遇到困难?
- 最重要的集成或依赖项是什么?
- 如果将产品分为不同的层次,会是什么样的?是按人们执行的任务组织,还是按他们使用的功能组织?
了解你的写作对象
按用户旅程组织,而非按产品功能
| 以功能为中心(应避免) | 以旅程为中心(更好) |
|---|---|
| 核心 API | 开始使用 |
| 身份验证 | 进行身份验证 |
| Webhooks | 发送你的第一个请求 |
| 速率限制 | 处理错误 |
| SDKs | 投入生产 |
管理深度和广度
- 将顶级部分控制在七个或更少。 当用户需要扫视和评估更多选项时,认知负荷会增加。
- 优先选择深度而非广度。 一个包含五个子部分的顶级部分比 20 个顶级项目更容易浏览。
- 不要将关键内容隐藏在两层以下。 如果用户必须点击三层才能到达经常需要的页面,请考虑提升该内容的层级。
- 对面向任务的部分使用动词(“身份验证”、“部署”、“监控”)
- 对参考部分使用名词(“API 参考”、“SDKs”、“更新日志”)
- 避免使用用户不认识的内部术语
- 保持标签简短——最好不超过 4 个词
验证你的假设
追踪真实的用户旅程
- 入口点: 用户从哪里开始?他们来自搜索、支持工单还是直接来自你的产品?
- 导航模式: 用户是否遵循预期的结构,还是走了意想不到的路径?
- 摩擦点: 用户在哪里停顿、回退或放弃会话?
- 搜索行为: 用户是否搜索了导航标签中没有出现的术语?这表明存在术语不匹配。
用真实用户进行测试
识别和修复常见问题
顶级部分过载
重要内容被埋没
部分名称不清晰
随时间迭代
- 每当产品发布重大变更时审查导航。 新功能通常会暴露结构性缺口。
- 每季度检查搜索分析,找出用户搜索但未反映在导航标签中的术语。
- 每年重新审视顶级结构。 随着文档的增长,在 20 个页面时有效的方式在 200 个页面时可能不再适用。
常见问题
我应该按产品功能还是按用户目标组织导航?
我应该按产品功能还是按用户目标组织导航?
在大多数情况下,按用户目标。基于功能的导航对于已经理解架构的产品团队来说有意义,但用户来到文档是为了完成某件事——而不是浏览功能。围绕用户试图做的事情进行组织,并将功能归类到它们所支持的任务下。
我应该有多少个顶级导航部分?
我应该有多少个顶级导航部分?
目标是 5 到 7 个。关于认知负荷的研究表明,用户在决策疲劳出现之前可以舒适地评估大约 7 个项目。如果你有更多,寻找可以合并为一个包含子部分的单一部分的自然分组。
如何处理面向多个受众的文档?
如何处理面向多个受众的文档?
首先,判断你的受众是否足够不同以至于需要独立的结构。如果管理员和开发者都需要入门,一个共享的”开始使用”部分可以很好地配合针对特定受众的子部分。如果他们的旅程根本不同——不同的产品、不同的用户画像——考虑独立的文档站点或基于选项卡的导航,以清晰地分隔两条路径。
我什么时候应该重组导航?
我什么时候应该重组导航?
当用户数据显示持续的导航失败时进行重组——索引页面的高跳出率、频繁搜索你期望用户直接导航到的术语,或者支持工单表明用户找不到明显的内容。避免仅凭直觉重组。重组的成本(书签失效、重新学习、重写内部链接)是真实的,因此确保数据支持这一决定。
如何防止导航随着文档增长而变得混乱?
如何防止导航随着文档增长而变得混乱?
在你的内容工作流中建立审查环节。添加新页面时,在开始编写之前就要求确定它们在导航中的位置。通过提前做出位置决策来维护连贯的结构,比在数十个页面积累在错误位置后再重组要容易得多。