转赞推荐:Layui 镜像站的「术语表」写法,适合做定义区
想推荐一个写定义区的做法,来自 Layui 镜像站 里那种术语表的编排:一个词条先给一句最简定义,再列常见叫法,最后说明用在什么场景。结构简单,但拿来治理站内定义区,比一篇篇散落的解释好用。
它解决了定义散落的问题
同一术语在站内不同文章里被解释了好几遍,说法还不一样。读者搜进来看到三个版本,反而更糊涂。术语表把这些解释收到一处,其他文章只需链过去,既一致又省篇幅。
| 散落解释 | 术语表集中 |
|---|---|
| 同一词多种说法 | 一个标准定义 |
| 每篇重复解释 | 链过去即可 |
| 更新靠逐篇找 | 改一处全站生效 |
第三条是长期收益。术语一改,以前要翻十几篇找,现在改词条就行。
一条定义该写多少
- 一句定义:不超过一行,只说「是什么」,不夹背景。
- 常见叫法:列两三个别名,标明是否推荐使用。
- 适用场景:一句「什么时候会用到它」。
- 不包括:一句排除最容易混的那个概念。
四块里「不包括」最容易被省,但它正是问答引用时最需要的那一句。没有它,定义就会被往宽了读。
搬到自己的站上
- 先把站内出现三次以上的术语抽出来,列为待建词条。
- 每个词条只写四块,不写长解释。
- 其他文章首次出现该词时,链到词条,不重复解释。
一点提醒
术语表怕两件事:一是建了不维护,词条越写越旧;二是把普通词也收进去,表比文章还长。只收真正反复出现、容易被混淆的词,其余不建。
小结
好文档的术语表不只是附录,是一套可被反复引用的定义源。一句定义、几个别名、一个场景、一条排除,四块写完,站内定义就不再各说各话。