代理IP的设置说明如果只写参数，同事拿到之后还是要来问一遍。一份能独立使用的说明应该包含四部分：适用场景、必填参数、操作步骤、验证方法。四部分齐全，对方照着做完就能用，不需要额外沟通。代理IP的设置说明写到能独立执行为止，代理IP的日常配置就不用反复解释。
四部分分别写什么
适用场景写清这份说明用在什么设备、什么用途。必填参数只列地址、端口、协议三项，账号密码单独传递。操作步骤按顺序编号，每一步一行。验证方法写清用哪个页面确认，以及什么结果算通过。代理IP的设置说明按这四部分写，篇幅通常在一页以内。
- 适用场景：设备与用途
- 必填参数：地址、端口、协议
- 操作步骤：逐步编号
- 验证方法：确认页面与通过标准
步骤要写到能照着做。写清楚在哪里找到入口、填哪几项、在哪一步保存。代理IP的说明里省略入口位置，同事往往卡在第一步，然后改成当面问，说明就失去了意义。
说明里建议留出改记录的位置，写清谁在什么时候改过哪一项。设置方式变动的时候在末尾追加一条，不必重写整份说明。代理IP的说明按追加的方式维护，历史改动也留着。
账号密码怎么给
不要写在说明里，用另外的方式单独传递。说明里只写从哪里取，不写具体内容。
多久更新一次
设置方式有变动的时候更新，没有变动的每半年看一次。看的时候核对验证方法是否还适用。
要不要配截图
关键页面配一张即可，不必每步都配。截图过多，说明反而没人愿意看完。
多人使用怎么维护
指定一个人负责更新，避免多人同时修改造成不一致。修改记录写在说明末尾，改动内容一目了然。
写到别人能独立做完为止。
说明交给谁维护
指定一个人负责更新，其他人有修改意见先提给他，由他统一改。多人同时改容易出现前后不一致，也说不清哪一版是最新的。代理IP的设置说明按单一维护人管理，版本始终清楚。
需要注意的是：说明要写清适用版本。设备系统更新之后入口位置可能变化，说明需要同步修订。
代理IP的设置说明按适用场景、必填参数、操作步骤、验证方法四部分写，步骤标到能照着做，账号另外传递，变动时在末尾追加。这样一份说明，同事拿到之后基本不需要再来问。