写一手标准、条理清晰、可读性强、美观的文档是多么重要!(另外说一下,作为技术人员,画一手好图,用于自己理解也很重要)
在大学期间,参加个比赛的训练,老师总让写文档,对于这些文字类的工作,我一直很反感,因为我认为在我的代码中问题、思路、解决办法、注意事项一切都已经写的很清楚,不需要再额外的写文档浪费时间,并且自己并不擅长也不喜欢做这种事。
但是,每每我回头想看看以前做的项目,我发现我根本毫无头绪,我甚至忘了写这些代码的目的,更别说从以前的经验中再学点什么。在自己越来越认识到一本系统性的书带来的帮助时,我也越来越了解一个总结性、概括性、甚至程序中的纠结过程,这些文档在这个项目之前、中、后带给我的作用。
那么,如何写一手标准文档,让你的文档更清晰、条理性、规范性、可读性和美观性?(具体可以参照一本书的结构)
(以下纯属自我瞎编,具体的还是多写,总结)
写前:
首先要知道写什么(主题)
分为几部分来写
写时:
在文章的最开始要亮明自己的主旨,和文章大致结构,不然读半天,可能还不知道你在写什么。
标题分行明显
各段对齐
重点词字要突出
写后:
写后一定要自己读一遍,检查语句是否通顺、逻辑是否出现混乱;过几天后再读一遍,你会发现你自己也不知道写的啥玩意,hhhhh,所以几天后修改一遍是很有必要的,因为你自己能发现你写的文档出现了哪些问题。
检查格式
注意语句通顺