代理IP的第十个坑平时最不显眼：整套用法只存在于几个人的印象里，没有写下来。平时运行正常，一旦有人请假或者调整岗位，接手的人就要从头摸索。这类损失不会立刻体现，却会在关键时刻集中出现。
说明写四块就够
适用场景、必填参数、操作步骤、验证方法，四块是基本内容。适用场景写清用在哪类设备哪类任务，必填参数只列三项，操作步骤按顺序编号，验证方法写清通过标准。代理IP的使用说明按这四块写，篇幅通常在一页以内。
- 适用场景：设备与任务
- 必填参数：地址、端口、协议
- 操作步骤：按顺序编号
- 验证方法：通过标准
步骤要写到能照着做。写清在哪找到入口、填哪几项、在哪一步保存，接手的人照着走一遍就能完成。代理IP的说明里省略入口位置，对方往往卡在第一步就改来问，说明也就失去了意义。
说明末尾留一块改动记录，写清谁在什么时候改了哪一项。用法变动时追加一条，不必重写整份文件。代理IP的说明按追加方式维护，历史改动也看得见。
凭据写不写进说明
不写。说明里只写从哪里取，具体内容用另外的方式单独传递。写在说明里，说明本身就变成了一份需要额外保管的文件。代理IP的凭据与说明分开管理。
写下来，才算交付。
说明用什么形式写
普通文档即可，不必做成系统。文档的好处是改动方便，追加一条就能更新。代理IP的说明以文档形式维护最灵活。
改动记录写在哪
写在说明末尾，一行一条，写清时间、改动项、改动人。改动记录和正文放在一起，不容易丢。代理IP的说明按追加方式维护。
多久看一次说明
每半年看一次，确认步骤与入口是否还适用。设备更新之后入口位置可能变化。代理IP的说明按半年一次的频率复核。
交接时怎么用这份说明
让接手的人照着走一遍，有问题当场问。走一遍比读一遍印象深。代理IP的交接包含一次照着说明的实操。
需要注意的是：说明要指定维护人。没有明确维护人的文档，通常半年之后就没有人更新了。
代理IP的用法只留在几个人的印象里，是十种坑里最容易被放过的一个。适用场景、必填参数、操作步骤、验证方法四块写成一页，末尾留改动记录并指定维护人，代理IP的日常使用就不再依赖具体某一个人。