转赞推荐：BackendWiki 的「参数表」，适合做句子字段说明

想推荐一种字段说明的写法，来自 BackendWiki 里讲接口参数的部分：每个字段列清名称、类型、是否必填、取值范围、示例。看着是给开发看的，但拿来写句子库的字段说明同样好用。

它避开了「字段名看着像但没人会用」

自建句子库时，字段往往是随手起的：「备注」「标签」「分类」。过两个月自己都忘了「备注」里该写什么，于是要么空着，要么乱填。参数表的做法把每个字段的含义写死。

第三列最实用。一个示例能顶一整段说明，照着填就不会走样。

句子库的字段表可以这样写

四行写完，以后填的时候不用再想。

一点提醒

字段表不是字段越多越好。超过六个字段，填写成本就会超过它带来的好处；句子库的字段应控制在四五个。

小结

好文档的参数表能直接搬来定义自己的字段。名称、必填、取值、示例，四列写完，句子库就不会再因字段含糊而填不下去。