先把「怎么装、怎么用」写成条目
客户端刚上线时,上手类问题占了绝大多数。我们把它们按操作先后排列,第一条编号就是 001——从哪一步开始、下一步在哪里,条目标题里就能看清楚,不用通读一整篇。
- 上手与安装主题成形
- 操作序号自 001 起排
最早那几年,被问到的其实是同一批问题:第一次打开该看哪一页、某条记录怎么找回来、换了设备之后还在不在。答案散在十几个地方,每来一位新用户,就得从头讲一遍。
于是我们把顺序倒过来:先把问题查清楚,再决定内容怎么排。操作性说明统一收进帮助文档,按三位序号编排,从 001 往下走;案例按月归拢,落到同一个主题目录里。你只要记住序号,就能直接落到那一步。
这条思路到今天没有变过。经常来的人应该走得更短,第一次来的人应该敢往下点,隔了半年再回来的人应该还认得原来的路。内容不是发完就算的一次性材料,它是要被反复打开、反复修订的长期资产。
六轮大版本,各自解决了一类麻烦。往下翻,收藏、导出和中文命名导入是怎么一步步长出来的,看得到来路。
客户端刚上线时,上手类问题占了绝大多数。我们把它们按操作先后排列,第一条编号就是 001——从哪一步开始、下一步在哪里,条目标题里就能看清楚,不用通读一整篇。
内容多了以后,找东西比读东西更费时间。这一阶段把站内内容划成上手与安装、目录与检索、收藏与导出、导入与命名、账号与设备、版本与更新六个主题,站内检索成为最常用的入口。
同一批条目会被反复打开,于是加入收藏夹分组。单个收藏夹最多容纳 500 条,分类自己定;收藏和导出都对应帮助文档里的操作序号,想找原始步骤随时能回去。
不少人会把步骤整理给同事,或者存起来备查。导出因此提供 PDF 与纯文本两种格式,导出的内容保留中文标题,拿出去不用再手工改一遍。
导入端支持 .txt、.csv 与 .json 三种文件,单个文件不超过 20 MB,文件名和内部条目标题都可以直接用中文写。对中文用户来说,这曾经是最容易出错的一步。
当前版本把客户端启动到内容目录首页的平均耗时压到 1.8 秒,检索平均响应在 300 毫秒以内;适配 iOS 15 及以上系统,iPhone 与 iPad 都在支持范围内。
内容编辑部有 14 名编辑,选题、采写、案例采编都在这里完成。另有 6 名文档工程师,专门盯操作序号和结构:同一条步骤在两个版本里的编号是否一致、类目归属有没有错位、配图里的界面是不是当前这一版。
两拨人共用一张排期表。一篇文章从提出到上线要走完六步,其中最耗时间的不是写,而是在真机上把每一步重新走一遍。
从站内检索词、客服反馈和版本改动里挑出真正高频的问题。同一个疑问反复出现,就值得写成一条。
编辑落笔,先给结论再列步骤,每一步对应一个操作序号,配图优先用界面局部特写而不是整屏截图。
文档工程师在真机上把步骤走一遍,确认在当前客户端版本里每一步都走得通,没有跳步也没有多余动作。
按三位序号排进对应类目,与相邻条目的先后关系保持一致,避免后来插入的内容把已有的编号挤乱。
图文说明与案例条目同时挂进主题目录,站内检索立刻可以命中,收录进当期目录索引。
上线后继续跟用户反馈,表述有歧义的地方在下一次版本校对时改掉,并把改动同步到引用过它的条目。
帮助文档累计收录,覆盖 9 个类目,操作序号从 001 顺序排到今天
带完整操作步骤的图文说明,每一步都能单独定位
案例合集连续发布,每期收录 8 到 15 个案例,按场景、操作、整理、检索四类归档
内容中心月均访问量,其中重复访问用户占比 62%
服务范围覆盖的中文用户所在地区
从上手与安装一路排到版本与更新,日常会查的内容都在里面
每月更新两次,新增条目和调整过的条目都会重新排进主题目录,检索结果随之刷新。
每月出一期,最近一期收录 12 个案例。想看新东西的话,一个月回来一趟就够了。
随客户端版本同步校对。客户端改一步操作,对应的图文说明和操作序号在同一次更新里调整到位。
每季度一份,围绕版本迭代和具体使用场景展开,比单篇说明更长,比案例条目更成体系。
每年两次全站走查,把失效条目、过期表述和走不通的路径一次清掉。
保留 5 年。超出期限的内容会打上归档状态,仍可查阅,但不再作为当前版本的参考。
与三家字体及图库供应商保持合作,站内用到的纹理、图标与案例配图都来自合作采购,具备可商用授权,不会出现来源不明的图片。
案例配图以界面局部特写和抽象光影为主,画面统一压在同一色温上。看案例的时候视觉是安静的,注意力留给步骤本身。
标题用衬线体,正文用无衬线体,操作序号和版本号用等宽字体。三种字体各管一段,翻目录时能一眼分出层级。
深靛底色上,暖金用来标章节与操作序号,珊瑚橙只出现在更新时间上,青玉只用于检索命中和状态提示。长文连读十几分钟,眼睛不会累。