品牌手册 · 2019 年起持续维护
一份目录,
长成一张阅读地图
加拿大28指南自 2019 年起为中文读者整理相关资料,把散落在各处的说明收进一条读得下去的路径。今天这份工作由 13 名编辑、校对与技术支持共同承担,沿着先给结论、再给步骤的顺序持续更新。
从一张目录开始
2019 年,几位做中文技术文档的编辑碰到同一个麻烦:关于加拿大28的说明散落在不同地方,新来的人要花很久才知道先看哪一份,看完一份又不知道下一份在哪里。他们先做了一件很朴素的事——把手上零散的内容编成一份目录。
目录越写越长,先后顺序就自己浮了出来。哪一份适合第一天读,哪一份要等遇到具体情况再翻,哪一份是给已经上手的人排查用的,条目之间慢慢排出了次序。今天大家看到的阅读路径,底子就是那张目录。
目录最初只有十几个条目,按“先读什么”排列,而不是按学科分类。这个习惯一直保留到现在:位置由读者所处的阶段决定,而不是由内容属于哪一类决定。
队伍从最初的几个人扩到今天的规模,但判断没变过——如果一位新读者打开页面后还要自己想下一步去哪,这份目录就没有排好。
先让人找得到入口,再让人愿意读下去。这是从第一份目录起就没有改动过的一条判断。
阅读路径怎么排
每一篇都按同一个顺序落笔:先用一句话说清这件事的结论,再拆成可以照着做的步骤,最后补上背景和例外情况。急着解决问题的读者读完第一句就能走,想弄明白来龙去脉的读者往下看,两部分互不打扰。
栏目也是按读者所处的阶段排的。同一个问题,刚接触的人和已经用了一段时间的人需要的答案并不一样,所以入口分成三条,各自的写法和深浅都不同。
- A
- B
- C
三级校对与版本管理
一篇文档从成形到发布要过三道关。编辑负责把事情讲明白,写出初稿和步骤;校对把条目编号、版本号、分类归属逐一比对,确认前后说法不打架;技术支持在真实设备上把每一步走一遍,确认写下来的操作确实能走通。
三道关各管一段,谁也不必替别人兜底,出问题也找得到是哪一环。正是这套分工,让 148 篇帮助文档在多次改版后仍然保持一致的写法和编号。
-
资料索引v3.2
条目编号、分类归属与置顶更新时间以这一版为准。
-
苹果端帮助文档第 5 版
按步骤一到步骤三重写,每步补上界面示意。
-
帮助中心栏目指引第 4 版
按新手资料、苹果端文档、反馈入口的顺序重排。
旧版本统一收在版本归档里,需要对照修改前后差异的读者可以随时取回。
团队与更新节奏
内容不是一次写完就放着不动。每周有一次内容例会,定下这一周要补哪几条、哪几篇需要重写;帮助文档每两周维护一次,把新出现的说法和截图替换进去;每月做一次反馈复盘,把反复被问到的内容补进帮助中心,通常七个工作日内就能查到。
遇到分类调整或大范围改写,按季度发布一次重大版本,并在更新动态里写清改了什么。每月平均处理约 260 条用户反馈,这些反馈是决定下一轮写什么的直接依据。
节奏固定下来之后,读者能预期什么时候会看到变化,团队也不必每次从零决定先做哪件事。
内容规模与分类
资料按用途分成六类,取用时先看分类,再按版本号确认是不是最新的一版:
- 新手路径
- 资料下载
- 苹果端帮助
- 反馈指引
- 常见问题
- 版本说明
站内搜索支持按栏目、资料类型和版本号筛选,知道关键词就能直接落到具体条目;不确定从哪一类进,回到对应阶段的入口即可。
下一条路径
读到这里的读者通常分两种情况:准备动手取资料,或者手上正有一个具体问题要解决。按自己现在的状态选一条就好。
想先看看最近改了什么,可以翻 更新动态 里的版本条目。