编写技术分析文档的总结经验

今天评审我写的一个MAC收发包的指导文档,我本来以为自己写的文档还可以,但是当评审的时候却被泼了一身冷水,甚至被评价为没有任何参考价值,这对我的大几很大,但是很快我也总结了一下在评审我文档时指出来的一些意见:

1. 第一部分:概述,主要讲什么,有什么目的;

2. 第二部分:对要讲述的内容先有个总的概述,然后从特例的角度分析,依次介绍各部分,将大家都相对来说清楚的地方稍微一带而过,稍微复杂的精讲,尤其是要善于将要将讲述的内容修改为流程图的形式,这样对于理解还有描述有很大的帮助,,并且比较形象;

3. 最忌讳的就是讲述的内容不清楚还有有错误,其次就是错别字的问题;

4. 如果文档中引用到一部分的英文文档,如果不是很长的话尽量保持英文状态,没必要强制的翻译,有时候英语对于大家的理解会更好些。

也许叔本华是对的,人与人的距离太远会寂寞到寒冷,

编写技术分析文档的总结经验

相关文章:

你感兴趣的文章:

标签云: