一个不会写技术文档的运维不是合格的运维,技巧+心态=完美!

一个不会写技术文档的运维不是合格的运维,最近一直在做运维周边工作,兢兢业业勤勤恳恳的把这骨头给啃下来了,今天终于把研发出来的2个平台和一个小程序接口的功能技术文档给写完了。大佬们审核的时间,我就来这总结下这段时间写文的一些注意点。
接收这个任务的时候,我就在脑袋里过了一遍逻辑,首先功能居多、从大功能到小功能,层级至少3级以上,这个文档格式要怎么处理呢?
NO.1 格式处理:通过搜索阅读了其他文档格式确认了文档的标题和正文的格式,如图

在这里插入图片描述

NO.2 层级处理:功能多的话需要使用层级处理,如图在这里插入图片描述
NO.3 功能指引截图,给箭头标签,利用微信截图功能可以快速达到编辑效果,非常实用。pc端打开微信,皆可以按住 ALt + A 截图后编辑加箭头都可以,如图
在这里插入图片描述

学会了这些功能后,就是文档整理的逻辑了。想要快速整理文字格式内容,必须思路非常清晰,那么怎么快速形成逻辑呢,我自己有自己的处理方式;
首先把格式确定调取,其次进去格式写文字,由大到小的输出,把一个大功能和小功能描述清楚后确定好逻辑了,这时候再一个个对应的去加上相应的流程逻辑图片,截好图后调整好距离合适,那么一个大功能做完了以后,再继续做下一个大功能。这样处理不用遗漏功能,另外将目标细化可以让自己处于一个及时完成小目标的心态中,有点小满足,将每一个大功能完善好了,那么文档也就一步步趋于完善状态了。
一开始我写的时候真的心里一万个草泥马奔腾,后来用了这个方式方法,觉得自己上手了,速度加快了同时心里也很自在,技巧加上愉悦的工作心态,促使自己在规定时间完成了任务。分享出来给大家,希望大家一起进步哦,你有好的方法也可以分享给我,谢谢哦!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值