写文档应该是一个什么样的工作呢?应该是非常重要的,但是有趣的是文档虽然重要,但是并不是说它需要很好的coding能力,它需要的是编写人员的综合能力。这个可是困难了,文档我写过不少,其中都是自己摸索着写的,也不知道写的好不好,更不知道写得对不对,只是想当然的按照书上的格式来写。
其实写文档学问很大,中间有许多细节要注重的,这比写代码困难多了,写代码只是一个段一段的写,思维通常可以维持在一个地方不需要转变。而写文档就不一样了,下笔的时候要考虑语言表达的习惯,要注意读者的水平层次,要主要用词的习惯,这还必须根据读者的不同而需要转变。和作家不一样,作家需要保持自己的风格,文档er则必须顺着读者来,另外,写文档前还要考虑总体的东西,有时写的时候需要把思维从局部切到整体,从细节切到架构,我觉得写文档可以单独设一门课程了。