攻略页的「适用版本」该写在哪个位置
攻略失效往往不是写错,而是读者没看见它写的是哪个版本。同一套打法换一次更新就不成立,页面却不告诉人家这一点。结论先给:适用版本要写在标题正下方、正文第一段之前,并且写进页面里能被单独看到的字段,不要塞在文末备注。
三个位置的取舍
| 位置 | 效果 | 判断 |
|---|---|---|
| 标题正下方 | 读者动手前就看到 | 推荐 |
| 段落中间 | 读到时已经照做了一半 | 不推荐 |
| 文末备注 | 基本等于没写 | 不推荐 |
原因很直接:版本信息的作用是让人决定「要不要照着做」,这个决定发生在读步骤之前。放在后面,它只能用来事后解释为什么没成功。
写法也要能独立成立
别写「适用于当前版本」——「当前」会变。写成具体版本号或具体更新名称,再补一句限定:「该版本之后若调整了某项数值,本页步骤中的第三步不再适用」。这样即使页面没及时更新,读者也能自己判断哪一段可能失效。
BackendWiki 里讲接口文档时有个类似习惯:适用范围写在最前,且指明「从哪一版起生效」。把这个结构搬到攻略页,比在正文里反复强调「注意版本」有效得多。
顺手该补的两件事
- 每次更新后回看受影响页面,只改受影响的步骤,别全篇重写。
- 保留旧版说明的入口,方便还在旧环境的读者对照。
第二条尤其对长线内容有用:一刀切删掉旧版本,会让一部分读者突然失去参照。
小结
版本信息不是注释,是使用前提。写在最前、写成具体版本号、写清哪一步会失效,三条做到,攻略页就不容易被误用。