WD-STORY · 当前版本 v3.7
从一份平板适配说明,长成一套走得到底的文档手册
伟德主页的文档工作,最早是为了回答一个很具体的问题:同一套产品,放在 7 到 13 英寸的平板上到底该怎么登录、从哪一页查起、出了状况先看哪一条。为了让合作方和技术人员不必翻遍零散邮件去凑一个结论,我们把每一次适配、每一条说明都收进固定编号,一路修订到今天。
- 2019开始维护
- 48版本修订
- 12类说明文档
- 8文档维护成员
从一份平板适配说明开始
早期的适配结论散落在邮件、会议记录和临时整理的备忘里。同一台平板,有人说登录入口在设置页第二层,有人说换个浏览器就通了——结论都对,只是没人能一次找全。合作方派人来问,我们常要花半天把散落的答案重新拼起来。
2019 年,我们把这些答案收进同一个框架:给文档一个固定编号,给适配结论一个明确归属。最初只有两份,一份讲快速上手,一份讲登录与适配。编号定下来之后,讨论的重点就从「谁说得对」变成「看第几号文档」,一来一回省下的时间,比整理本身多得多。
批注:编号是怎么排的
WD-DOC 后面跟两位序号,序号一旦发出就不再回收。文档内容可以改,编号不动,外部引用才不会错位;一份文档作废,它原来的位置也照样保留。
每一版都留下痕迹:48 次修订与季度巡检
文档一旦发出去,就会被人拿去做培训、写进交接材料、贴进内部群。既然有人在用,改一处就得留一笔。从 2019 年到现在,累计完成 48 次版本修订,每次只动该动的那几份,改完把版本号往前推一格。
-
01
修订留痕
每次改动记下动了哪一份、为什么动。旧版本按编号归档,三个月后回来核对仍然对得上号。
-
02
分类定档
12 类说明文档各占一档,编号从 WD-DOC-01 到 WD-DOC-12,覆盖快速上手、登录与适配、平板端操作、故障排查一直到使用条款。
-
03
季度巡检
每季度跑一次链接与下载文件可用性检查,最近一次巡检修好了 17 个失效锚点,把指向错位的入口重新对齐。
-
04
先看后下
每份文档都能先在线预览再决定是否下载,PDF 文件附带 SHA-256 校验码,拿到手就知道是不是同一份。
遇到旧版入口找不回来、或者平板端登录卡在某一步,常见问题里已经把排查顺序按步骤写好了。
8 个人,两条线,把每一份说明盯住
文档维护小组一共 8 名成员,按两条线分工,每周对一次进度。人数不多,但每一份发出去的说明都有人署名负责。
登录适配与下载支持
专门盯平板和浏览器上的登录路径,处理下载失败、校验码对不上这类具体问题。来信通常在当天就能得到答复,不用来回猜。
文档撰写与版本归档
按文档类别分工撰写与复核。新版本发布前由另一位成员通读一遍,确认步骤真的能照着走通再放出去。
适配测试覆盖 9 个主流浏览器版本与 4 类平板尺寸区间,从 7 英寸到 13 英寸都有对应的操作路径。同一处登录入口,在不同尺寸上的落点不一样,测试时就分别记下来,而不是拿一台设备的经验套到全部。
版本刻度:从 v1.0 到 v3.7
版本号是这条线上最直观的刻度。每往前推一格,都对应着服务范围的一次扩大。
-
v1.0 · 起点
先让编号立起来
最初的两份文档定下 WD-DOC 前缀与两位序号,解决的是「同一个问题有五种说法」。
-
v1.6 · 次年
平板端单独成册
7 至 13 英寸设备越来越多,平板端操作从登录说明里拆出来单独编号,同一个入口不再挤在一页里讲。
-
v2.0 · 扩展期
产品线工具与故障排查并入
6 条产品线的使用工具开始统一挂到编号下,故障排查单列一档,技术人员不用再跨三份材料对照。
-
v2.4 · 上一季之前
校验码与在线预览
下载文件附上 SHA-256 校验码,先预览再下载成为默认习惯,发出去的说明能被确认是同一份。
-
v3.0 · 近期
旧版入口有了固定位置
页脚第二栏固定放旧版打开方式,习惯老路径的用户不必每次重新找路。
-
v3.7 · 本月
平板入口与资料抽屉重新编号
登录入口按设备尺寸重新排序,12 类文档的抽屉索引同步调整,编号一眼能找到。
谁在读这些文档
文档被翻开的次数,比任何一段自我介绍都更能说明它好不好用。这些访问大多发生在具体的事情上:确认一台旧平板还能不能登录、把一份说明转给刚接手的同事、晚上十点还在核对一条适配结论。
- 文档访问覆盖的省级行政区
- 31 个
- 资料下载栏目月均访问
- 2.6 万次
- 最近一次巡检修复的失效锚点
- 17 个
服务范围也跟着这些访问慢慢铺开:从个人用户查一次平板登录,到合作方把整批说明文档纳入内部培训材料,需求不同,落到的还是同一套编号。需要自己动手查的时候,从资料索引进去最快;想先看看最近改了什么,品牌专栏里按修订记录排着。