转赞推荐：从《1Panel 官方文档》学“版本无关”的写法

在 万象云档 翻《1Panel 官方文档》时，注意到一件小事：有些说明只讲概念和步骤，不写具体版本号，也不绑定某次界面调整。这类内容换个版本、过一年，读起来依旧成立。这个写法，做经典句子的人反倒很值得借。

什么叫版本无关

文档里最容易过时的句子，是“在当前面板点击某某按钮”。按钮一改名，整句就废了。版本无关的写法会先讲清要达成什么、依据是什么，把具体界面留给会变的那部分。

换成短句写作，对应的就是：别把句子钉在某一年的说法、某件热点、某个具体物件型号上。写“号码还在，没拨过”，比写“那年之后就再没发过消息”活得久——后者需要读者知道“那年”。

三条可以借的习惯

• 先写处境，不写时间：处境哪一年都成立；
• 把可变的细节放在句子外：真要标注日期，写成字段，别塞进正文；
• 定义自带边界：不靠“如上所述”“前面提到的”这类指代。

第三条在 Layui 镜像站的术语与组件说明 里也能看到：一句话能独立读懂，不依赖前文。

一点延伸

文档还要处理另一件难事：既写清当前怎么做，又不让以后的人误读。它的做法是把时间和适用范围单列，而不是混在说明里。句子库也一样，记下的月份、改动记录放在字段里，正文只留那句话。字段设计可参照 BackendWiki 的表格化写法。

小结

一份工具文档，把“怎么让内容不过期”演示得很具体。想让一句短句经得起复读，秘诀和它一样：把会变的信息挪出正文，只留下不依赖时间的那一点。