如何写文档
主题:写一手标准、条理清晰、可读性强、美观的文档是多么重要!!!! & 英文词汇量是多么重要!!!!
(另外说一下,作为技术人员,画一手好图,用于自己和他人理解也很重要)
在大学期间,参加比赛的训练,老师总让写文档。对于这些文字类的工作,我一直很反感,因为我认为在我的代码中问题、思路、解决办法、注意事项一切都已经写的非常清楚,不需要再额外的写文档浪费时间,并且自己不擅长也不喜欢做这种事。
但是,每每我回头看自己以前做的项目,我发现我根本毫无头绪,我甚至忘了写这些代码的目的,更别说从以前的经验中再学点什么。在自己越来越认识到一本系统性的书带来的帮助时,我也越来越了解到一个总结性、概括性、程序中纠结过程的文档,在项目前、中、后期带给我的帮助。
那么,如何写一手标准文档,让你的文档更清晰、条理性、规范性、可读性和美观性?
(以下纯属自我瞎编,具体实施方案是Reading,Writing and writing,然后从中总结)
写前:
首先要知道写什么(主题)
分为几部分来写
写时:
在文章的最开始要亮明自己的主旨,和文章大致结构,不然读半天,可能还不知道你在写什么。
标题分行明显
各段对齐
重点词字要突出
写后:
写后一定要自己读一遍,检查语句是否通顺、逻辑是否出现混乱;过几天后再读一遍,你会发现你自己也不知道写的啥玩意,hhhhh,所以几天后修改一遍是很有必要的,因为你自己能发现你写的文档出现了哪些问题。
检查格式
注意语句通顺
既然已经写到文档了,就顺便写一下最近练的英语听力吧。因为从中我真的发现像英语这种语言,词汇量的多少是非常重要的!!
在YouTube上看纯英文的英语教学视频,视频中有真人讲解,并且发音清楚,真的非常棒。
推荐两个初级的频道:Learn English with Emma [engVid] 、 Gabby Wallace - Go Natural English,
进阶的推荐:The English Coach (语速较快) 、 Clear English Corner with Keenyn Rhodes (语速较慢,主要是纠正发音,关于现实生活中实际发音技巧的视频)
非常感谢上面这些频道,让我对于英语听力,自我感觉还算良好hhhhhh。
但是,发现一个问题:比如听力中遇到不懂的单词,虽然可以猜,但时不时就遇到这种情况,仍然感觉很不爽;另外在看一些专业性视频时,更是一头雾水,这让我很郁闷。词汇量不仅让我在日常听力上出现问题,更限制了我试图理解专业视频的能力。
这里我发现词汇量是多么的重要!!!!
于是百度了一下:以英语为母语的人,在遇到不懂的单词时是怎么做的,他们是怎么扩展自己的词汇量的。
得到一个非常中肯,同时我自己也非常认同的一个方式:Reading,Reading and Reading.
仔细一想,确实是这样,我试图在YouTube上看ARM讲解视频,我却连一本关于ARM的英文书都没翻过,有关ARM的专业词汇知之甚少,这直接性地阻止了我理解这个视频。一本关于ARM的英文书,不仅可以让你更多的了解专业知识,在专业词汇方面也是非常有帮助的。