团队里总有人需要一份关于代理IP的基础说明，写的人往往一写就是好几页，读的人却只看开头。更有效的做法是控制在一页内，用最少的信息覆盖最常被问到的部分：它是什么、能做什么、不能做什么、遇到问题怎么办。
一页说明的内容顺序
开头一句定义，讲清它是中间的转发环节。接着三条用途，用动作描述写具体任务。再接着三条边界，写明不要用在哪些场合。最后一行写联系人。这个顺序的好处是先给概念再给场景，读者不会一上来就被细节拦住。
- 一句定义
- 三条用途
- 三条边界
- 一行联系人
一页说明的好坏，取决于读的人能不能照着做。判断方法很简单：让一位没接触过的同事只读这一页，看能不能独立判断某个任务该不该用。做不到就说明还缺内容，做得到就说明篇幅刚刚好。免费代理IP的说明尤其要写成这样，因为它的适用场景边界比较窄。
哪些内容可以省
协议细节、参数配置、链路图这些都可以省。它们对判断该不该用没有帮助，放进来说明会变长，重点反而被淹没。代理IP的链路细节就属于这一类，留在技术文档里更合适。需要这些内容的人通常是技术岗位，可以直接另附一份技术文档，两份材料分开，各取所需。这样一页说明就能一直保持简洁，免费代理IP的适用条件也不会被细节埋掉。
要不要留版本号
要留。写清更新日期，读的人才知道手里这份是不是最新的，也才知道其中的代理IP说明有没有更新过。没有版本信息的说明，一旦有两份同时流传，很难判断该照哪一份执行。
怎么让人真的会看
把说明放在工具旁边或者流程说明的开头，而不是单独存成一个文件。存放位置决定了它会不会被打开。免费代理IP的使用场景零散，说明放在需要它的地方，才可能真的被用到。代理IP的说明尤其要就近放，因为它的使用场景很零散。
需要注意的是：一页说明要定期复查，尤其边界那三条。业务变了之后，边界可能已经不再准确，而沿用旧边界比没有说明更容易出问题。代理IP的边界尤其要按时复查。
先定篇幅，再定内容。
写什么是代理IP的一页说明，把定义、用途、边界、联系人四块按顺序放进去，就够用了。