操作类、代码demo文档编写原则

根据之前的经验，总结了一些文档编写中需要注意的事项、用户阅读文档常见需求：

一.操作类、代码demo文档

1. 此文档用于解决：xxxx
2. 给出具体登录哪个机器/哪类机器，ssh登录还是通过堡垒机登录，或者其他登录方式
3. 没有登录权限找谁开通
4. 给出文字版操作命令,wiki code模式给出，文本模式格式有问题：这里不要截图，用户习惯从wiki粘贴命令再修改之后执行，当然也不要写一个有危险的命令，而是里面参数用test等字符代替）
5. 给出操作命令正常返回内容，以及内容说明
6. 给出操作命令异常返回内容，内容说明，如何处理，用户无法处理的联系谁，提供什么错误信息
7. 整个操作流程必须经过文档编写者自己的验证，不要随便从网上找一个操作过程粘贴过来
8. 超过4步的操作，要有简洁的操作流程图描述
9. 复杂的操作流程/api，应该类比类似的其他用户常见系统/DB，对比进行描述，不要给用户罗列一堆名词
10. 总结：标准化、可实际操作、系统化能列出1，2，3项而不是逻辑混乱，语言简洁可读性高不要罗列不需要的名词（给出用户熟悉的系统/DB类比）