[阅读: 346] 2006-04-12 10:00:43
其实俺以前写文档也很头疼,憋了好长时间能写出俩半字来。最近在家休息的一个月中,写了N多的文档,有解决方案、需求分析和概要设计等不同的文档,现在觉得写文档也没那么难了。俺总结,写文档有两点要素:
第一,要考虑全面,思路清晰。其实,最开始写文档的时候难就难在不知道从何下笔。也许对要做的事情有一个考虑,但层次不够清晰,所以不知道从何下笔,按照什么样的结构写。这需要多看看一些好的文档,多学习别人的思考方式;再就是经验的积累,这就不是一朝一夕的事情了,要慢慢来。
第二,不要怕,下笔写。写技术文档并不需要太好的文笔。也许好的文笔写出来让人家看着很舒服,但不要过于注重这些。只要把要做的事情罗列出来,再把细节的东西都写上,一个文档也就出来了。