编写技术分析文档的总结经验
2015-03-25 23:28
260 查看
今天评审我写的一个MAC收发包的指导文档,我本来以为自己写的文档还可以,但是当评审的时候却被泼了一身冷水,甚至被评价为没有任何参考价值,这对我的大几很大,但是很快我也总结了一下在评审我文档时指出来的一些意见:
1. 第一部分:概述,主要讲什么,有什么目的;
2. 第二部分:对要讲述的内容先有个总的概述,然后从特例的角度分析,依次介绍各部分,将大家都相对来说清楚的地方稍微一带而过,稍微复杂的精讲,尤其是要善于将要将讲述的内容修改为流程图的形式,这样对于理解还有描述有很大的帮助,并且比较形象;
3. 最忌讳的就是讲述的内容不清楚还有有错误,其次就是错别字的问题;
4. 如果文档中引用到一部分的英文文档,如果不是很长的话尽量保持英文状态,没必要强制的翻译,有时候英语对于大家的理解会更好些。
1. 第一部分:概述,主要讲什么,有什么目的;
2. 第二部分:对要讲述的内容先有个总的概述,然后从特例的角度分析,依次介绍各部分,将大家都相对来说清楚的地方稍微一带而过,稍微复杂的精讲,尤其是要善于将要将讲述的内容修改为流程图的形式,这样对于理解还有描述有很大的帮助,并且比较形象;
3. 最忌讳的就是讲述的内容不清楚还有有错误,其次就是错别字的问题;
4. 如果文档中引用到一部分的英文文档,如果不是很长的话尽量保持英文状态,没必要强制的翻译,有时候英语对于大家的理解会更好些。
相关文章推荐
- 同一个项目的不同的项目工作经验总结--设计文档编写经验总结
- 电子银行业务分析系统—项目总结7. 项目技术经验
- 编写帮助文档经验总结
- 同一个项目的不同的项目工作经验总结--设计文档编写经验总结
- 同一个项目的不同的项目工作经验总结--设计文档编写经验总结
- 同一个项目的不同的项目工作经验总结--设计文档编写经验总结
- 同一个项目的不同的项目工作经验总结--设计文档编写经验总结
- 制作技术培训演示文档(PPT)的一些经验和建议
- 目前主流开发技术的分析和总结
- 上周技术关注:搜索引擎经验总结
- 存储过程编写经验和优化措施(来源自CSDN文档中心)
- 软件开发项目-文档编写标准化--测试分析报告
- 软件开发项目-文档编写标准化--项目开发总结报告
- 项目经验技术总结三:系统业务基础数据维护
- ASP下操作Excel技术总结分析
- ASP下操作Excel技术总结分析
- SQL注射技术总结文档
- 对目前主流开发技术的分析和总结 (转贴大富翁) ---- 献给困惑中的弟兄们
- 软件开发项目-文档编写标准化--总结
- 编写优秀技术文档的技巧