USAGE GUIDE
引用站内路径与版本号,三段写全就不走样
把游艇会206的一条栏目路径写进工单、内部文档或对外说明里,只要坐标写全,谁打开都落到同一处。下面四条覆盖最常见的引用与纠错场景,每条单独成段,可以挑着看。
版本号、栏目编号、路径序号,三段一起写
推荐写法
v3.2 · 03 · 012
版本号 · 栏目编号 · 路径序号,三段缺一不可
-
1.1
单独一串路径序号撑不起定位。同一串数字在不同版本里可能指向另一条路径,把版本号补在前面,读者才知道该翻哪一版。
-
1.2
写进文档时可以带栏目名一起写,例如「栏目索引服务(v3.2 · 03 · 012)」,读者复制编号就能在整页扫描视图里找到那一行。
-
1.3
引用旧版本时加一个归档标记,例如 v2.8 · 归档 · 03 · 012,并在旁边写明它在版本日志时间轴上的位置,翻查时不必从头找起。
-
1.4
口头沟通按版本号、栏目编号、路径序号的顺序念。三段都用等宽字形记录,念出来和记下来不会是两串字符。
-
1.5
长期维护的文档,建议固定写一个版本号,更新时整段替换,别让新旧编号混在同一页里,后来的人分不清先后。
版本往前走了,旧编号会退到归档里
索引跟着版本一起调整,栏目级路径会重排。这不是异常,是版本演进的正常结果,写引用时提前想到这一点就够。
-
2.1
站点保持每季度一次小版本、每年一次大版本的节奏,当前在用索引为 v3.2,覆盖 9 个一级栏目与 64 条栏目级路径。
-
2.2
新版本上线后,被替换的序号退出整页扫描视图,转入归档。跨年份的文档写版本号比写序号更稳妥,读者打开时能自己判断要不要换新。
-
2.3
27 个历史版本记录按版本号收在版本日志页,默认展开最近 3 个,更早的折叠起来,最早可追溯至 v1.0。
-
2.4
状态标识也能帮你判断:极光青是当前在用,冰蓝是维护中,信号橙是待更新。引用前扫一眼颜色,就知道这条路径处在什么状态。
-
2.5
文档里如果引用了待更新版本中的路径,建议顺手写上它对应的新版本号,读者打开时能看到更换进度。
文字可以直接引,图形与步骤照原样搬
说明文字改写与否影响不大,图形里的数字和序号一旦动了,指向的就不是同一条路径。
-
3.1
站内说明文字可以整段引用,注明来自游艇会206 并附上版本坐标就够了,不需要逐字改写。
-
3.2
示意图里的数字、序号和箭头方向请照原样保留。改动一处顺序,读者按图去索引里找,可能落到另一个栏目。
-
3.3
索引目录是三层结构:一级栏目、栏目级路径、版本坐标。引用时保持三层,把栏目级路径压成一级栏目,读者就找不到具体条目。
-
3.4
教程里的 24 篇步骤说明按步骤序号引用,例如「第 2 步」,跳步引用会让操作顺序错位。
-
3.5
要把站内图文放进印刷品、培训课件或对外说明材料,先发一封邮件到客服邮箱讲清用途,我们会回你当前版本里对应的写法。