我们要明白了写一份好的文档的重要性 以及写一个好的文档需要付出的艰辛的努力 下面简单总结下写文档的心得
一、标题必须明确 标题必须让对方一看,就能知道你这个文档到底是干嘛的,谁写的,什么时候写的。 比如,我最先的标题“UDP远程监控” 这么一个标题,人家一看根本什么都不知道,你这个是UDP远程通信的什么呢? 策划书?报价表?说明书?实现计划? 然后这是谁写的? 什么时候写的? 最基本的应该满足下面情况吧《UDP远程监控系统策划书—V1—李某某—20100909》 二、文章结构必须清楚 要说明的内容,必须清清楚楚一二三四一条一条列出来,合理利用WORD中的标题样式,写完后,从视图中的文档结构就能一眼看出整个文章的体系与内容 三、 看文档的一般都是老板,搞管理的人,他们不一定懂技术,所以没必要写一些很生涩的技术的东西,写的东西必须简单明了,让不懂技术的管理人员都能很简单的就能看明白,你到底能实现些什么功能,相对于别人的东西来说有什么优点,实现需要的代价是什么? 但是也有些文档可能技术人员也好看,那么我们必须布局好,提纲中能很简明的说出我们的功能,内容中可能具体大纲的说出实现方式。 一个文档,如果全是凌乱的文字,别人是不愿意看的,随便瞟一眼,如果没有提起人家的兴趣,可能他们就不看了。 所以,写一个好的文档,必须清清楚楚的搞好结构 例如: 一。 1.1 1.1.1 1.1.2 1.2 1.2.1 二。 2.1
同时一个好的文档必须是图文并茂的 很多很复杂的,需要用大段文字来描述的过程等信息,那么我们就用一个流程图来表示
四、 书要有目录,封面 文档也是同样 加入目录,封面,页面,页脚,页码,能让文档填色不少 五、细节 注意字体大小,标点符号,错别字等细节 六、语言 把文档发给姐姐看后,姐姐第一个印象就是语文太口语化,感觉不专业。 这也是需要注意的很重要的地方。
恩,大致总结就这么多吧。 今天去公司写了一下午的文档,呵呵,走的时候龙哥开玩笑说,我的奥拓变奥迪了。 呵呵,虽然是个玩笑,但是确实如此啦。
首先文档的变化就挺大的,然后总结收获也很多。
P.S. 第一个文档是我昨晚画了3个小时辛辛苦苦写的,写完后还自我感觉良好的感觉所有要说的东西都说了。。。 |
|