条目有哪些字段、每个字段填什么：目录站该不该把数据字典写成一页

做目录站的人心里都有一张隐形的表：条目有站名、官网、简介、分类、标签、截图、上线时间、审核状态……但这张表只在数据库里。于是每次有人来对接，你都要在聊天框里重新打一遍；每次换了维护的人，填字段的口径又变一次。

图片来源：网络，版权归原作者所有，侵权请联系删除

数据字典页到底写给谁看

把它当成一页普通文章来写，读者其实有三类，而且他们要的东西不一样：

读者	关心什么	页面该给什么
要提交或对接的合作方	必填哪些、格式怎么写	字段表加取值示例
来纠错的用户	哪几个字段能改、走什么入口	可修改字段标出来，配纠错链接
站内维护的人	字段含义和边界	每个字段的字数、取值、来源

顺带还有第四类读者：搜索引擎。这页的字段说明跟你条目页上的结构化数据是同一套词，等于给爬虫一份对照表，把「你们这个站的简介到底指什么」讲清楚了。

字段表怎么列才好用

别只写字段名。一行至少五列才够用：字段名、含义、取值示例、是否必填、来源。来源是很多人漏的一列——简介是自己写的还是抄官网的，上线时间是域名注册时间还是你收录的时间，标清楚了后面省掉无数争执。

取值示例一定要放真数据。写「站名：字符串」没人看得懂，写「站名：某某工具导航（不含口号和副标题）」才叫说明。字数限制也要写死，简介 80 到 150 字这类约束写在页面上，比写在审核员的脑子里管用。

版本化这件事不能省

字段是会变的。加了一个字段、废掉一个字段、把分类从单选改成多选，页面都要跟着改，并且在页顶标上更新日期，页尾留变更记录。老版本别直接覆盖掉，留一个归档链接，对接过的人需要知道自己当初对的是哪一版。

字段字典页的价值不在写出来的那天，在于半年后有人问「你们这个字段到底怎么算」时，你能甩一个链接过去。

有几类字段别往页面上放

内部用的东西不适合公开：条目的权重分和排序参数、审核备注、提交来源的 IP、联系人的邮箱和手机。这些字段你数据库里可以有，字典页上写「该字段不对外」就够了。

还有一类是容易被拿去反推的数据：某个条目被看了多少次、点击率多少。这类数字单个放出来，等于把对方站的流量规模间接公布，对方来问你要说法的时候你不好答。

写法上的几个细节

用真正的 HTML 表格，别截图。表格能被搜索、能复制、能翻译成各种设备宽度，截图三样都做不到。每个小节加锚点 id，方便别人链到具体字段。页面地址固定下来别动，它会被你的文档、邮件模板和合作方反复引用。

最后，把这一页链到提交页和纠错入口旁边。写在那里，比藏在页脚有用十倍。