编写技术分析文档的总结经验
来源:互联网 发布:javascript 关联数组 编辑:程序博客网 时间:2024/06/08 13:12
今天评审我写的一个MAC收发包的指导文档,我本来以为自己写的文档还可以,但是当评审的时候却被泼了一身冷水,甚至被评价为没有任何参考价值,这对我的大几很大,但是很快我也总结了一下在评审我文档时指出来的一些意见:
1. 第一部分:概述,主要讲什么,有什么目的;
2. 第二部分:对要讲述的内容先有个总的概述,然后从特例的角度分析,依次介绍各部分,将大家都相对来说清楚的地方稍微一带而过,稍微复杂的精讲,尤其是要善于将要将讲述的内容修改为流程图的形式,这样对于理解还有描述有很大的帮助,并且比较形象;
3. 最忌讳的就是讲述的内容不清楚还有有错误,其次就是错别字的问题;
4. 如果文档中引用到一部分的英文文档,如果不是很长的话尽量保持英文状态,没必要强制的翻译,有时候英语对于大家的理解会更好些。
1 0
- 编写技术分析文档的总结经验
- 编写优秀技术文档的技巧
- 编写优秀技术文档的技巧
- 编写优秀技术文档的技巧
- 学习编写java类的技术文档
- 程序员编写技术文档的新手指南
- 失败的项目总结经验
- 【每周技术文】只有不停的训练,总结经验,不断学习才可以成长。
- 小议程序员编写技术文档
- HTTP报文的一些总结经验
- IOS 多线程的编程总结经验
- 转载资深程序员的总结经验
- 初识DocBook(编写技术文档的工具)
- iBeacon技术分析文档
- 自动化测试之技术文档--好的技术分析链接
- 在项目前期需求分析阶段,需要编写的文档
- 编写文档的思路
- PRD文档的编写
- UFLDL上的ICA为什么一定要做PCA whiten
- 在视图中展示 rtf 域的值的方法
- 振兴中华——第四届蓝桥杯省赛C语言A组第3题
- LoadRunner的DFE功能
- 开源点评:Protocol Buffers介绍
- 编写技术分析文档的总结经验
- String to Integer (atoi)
- Thinking in java ——数组
- 使用Volley传输网络数据(官网教程)
- 吉他自学教程(一)-基础乐理
- svn server 配置 与TortoiseSVN、Ankhsvn+VS使用 及 问题
- [Python]网络爬虫(二):利用urllib2通过指定的URL抓取网页内容
- 最长回文子串
- 简洁代码解决PAT_1025_反转链表