有关技术文档的一点感想

   在IT行业很多的技术人员都不是很注重技术文档,或是没有明白技术文档的重要性。

   大多数的人都觉得文档的撰写,整理,归类是一件很麻烦的事,因而很多的时候为了规避麻烦就避而远之,在做有关文档的工作的时候,能省则省,能简略就简略。很多的程序员在写程序的时候竟然没有注释,很多的编程人员,包括电子工程师,在写程序的时候都没有对程序中重要的变量进行说明,在写函数的时候没有对函数的功能进行描述,没有传入参数,返回参数,以及中间重要变量的说明。

   前一段时间在学习ZigBee,看了人家TI公司Z-Stack协议栈中的代码,感觉那代码是一种艺术,看上去很美观,很有艺术感。基本上每一个函数都进行大量的说明,函数中的参数,变量以及返回参数都进行了详细的说明,看了一下函数的描叙就知道函数的功能,一目了然。

   我承认我也有很多这样的不足之处,但是自己在慢慢的改进,希望以后能克服这样的缺点。

   前一段时间一直在帮老师写那个专利申请书,感觉文档真的很重要。别人了解一个项目也是通过对项目有关的文档阅读而得知,文档撰写或是整理的不好,人家看不懂就出现摸棱两可的感觉,次数多了就会厌烦,人家也不愿意和你合作。在写程序的时候,尤其是程序的代码量较大的时候,一个人基本上无法完成,就必定要找人合作,最后进行程序联调的时候,看不懂别人的程序还是需要自己更多的时间进行解释,最终还是得不偿失。

    做挑战杯有一段时间了,本来想先把实物做好了,至于文档的整理只需要几天时间搞定的。但是后来发现很多东西没有相当,很多人家要求的描叙性文字很欠缺,很多地方需要查找资料,看参考文献,所以后来原本打算3天就搞定的东西,结果拖了一个星期,而且还经常把午休的时间投入,晚上还要忙到11点。结果上周交完报告的时候,人就生病了,回家静养了两天,还是得不偿失。所以以后还是要多多注重文档的整理。

    在此与大家共勉,在文档工作方面再接再厉,做到更好!

时间: 2024-08-10 21:30:19

有关技术文档的一点感想的相关文章

d3js技术文档

D3js技术文档 概述 D3 allows you to bind arbitrary data to a Document Object Model (DOM), and then apply data-driven transformations to the document. For example, you can use D3 to generate an HTML table from an array of numbers. Or, use the same data to cr

如何快速阅读并理解英文的技术文档

作为一名程序员,要实现我们的产品,首先需要选择一种或几种编程语言,其次是使用各种工具和第三方库. 而在这个过程中,就少不了对这些语言.工具和第三方库的下载和学习. 下载一般都非常简单,但是关于如何使用,相信大家都会有各种各样的学习方法. 但是不管通过什么方式,追根溯源都会来到官方文档. 那么问题就来了!目前来说,大部分的官方文档都是英文的,如何才能快速的理解并使用官方文档呢? 今天,把自己的学习方法拿出来,和大家一起分享一下,希望大家可以尽量少走一些弯路,尽快的找到bug的解决方法. 说起来很简

如何编写技术文档

最近在公司内部审查,我想不是我们中国软件行业的个别问题,相反,存在一定的普遍性.以下我列出了几个值得提高的地方. 1) 文档的格式上存在不一致性的问题.格式有时是这样,有时是那样.一篇好的文档我想不光是内容写得好,其格式是很重要的一部分.试想,如果我们拿到了一篇格 式上写得乱七八糟的文档,这一第一印象会影响我们的阅读心情吗?好的文档应当是从头到尾保持格式的一致性,这不仅仅是一种美,更是专业性的一种表现. 2) 写文档的作者不能很好的站在读者的角度去思考.要写出一篇好的支持文档,作者应当站在读者的

开源进销存PSI - 技术文档目录

开源进销存PSI技术文档目录 1.本地环境搭建 2.总体技术架构 PSI概要设计文档在这里

OCR识别技术文档识别怎么用

OCR识别技术文档识别的概括 我们常说的OCR.文字识别.OCR识别技术文档识别是指通过电子设备等将纸质上的文字识别出来,形成可编辑的文字. OCR识别技术文档识别的流程 随着扫描仪的普及与广泛应用,再加上摄像头迅速发展的手机等智能终端设备的应用,OCR识别技术文档识别软件越来越被应用于各种业务系统中. 常规的OCR文字识别处理的过程包括: 1.图像输入.预处理:二值化图片.噪声去除.倾斜较正: 2.版面分析:把页面分为横排文本.竖排文本.表格.图片等不同区域,帮助字符切割.识别OCR: 3.设

Atitit usrQBK1600 技术文档的规范标准化解决方案

1.1. Keyword关键词..展关键词,横向拓展比较,纵向抽象细化拓展知识点1 1.2. 标题必须有高大上词汇,参考文章排行榜,1 1.3. 标题带语言关键词c#.net js javascript  c++ python1 1.4. 标题最好有英文版本的,方便英文查询1 1.5. 标题atitit前缀,attilax总结结尾方便查询1 1.6. 标题后面带上版本号v2 qbf等,方便时间对比1 1.7. 正文要求 修辞好(引用典故名句,成语 等,使用修辞方法)2 1.8. 引用寓言故事 类

Xamarin技术文档------VS多平台开发

此技术业余时间研究,仅供大家学习参考,不涉及深入研究,有一定开发基础的人员,应该都能较快上手. 一.简介 Xamarin始创于2011年,旨在使移动开发变得难以置信地迅捷和简单.Xamarin的产品简化了针对多种平台的应用开发,包括iOS.Android.Windows Phone和Mac App.Xamarin由许多著名的开源社区开发者创立和参与,而且也是Mono项目的主导者--C#与.NET框架的开源.跨平台实现. 作为一个跨平台开发框架,Xamarin.Mobile有很多优点.在这一框架内

DL动态载入框架技术文档

DL动态载入框架技术文档 DL技术交流群:215680213 1. Android apk动态载入机制的研究 2. Android apk动态载入机制的研究(二):资源载入和activity生命周期管理 3. APK动态载入框架DL解析 4. Android 使用动态载入框架DL进行插件化开发 5. DL插件开发笔记 6. DL开发注意事项 附:DL层次结构图

Boost.Asio技术文档

Christopher Kohlhoff Copyright ? 2003-2012 Christopher M. Kohlhoff 以Boost1.0的软件授权进行发布(见附带的LICENSE_1_0.txt文件或从http://www.boost.org/LICENSE_1_0.txt) Boost.Asio是用于网络和低层IO编程的跨平台C++库,为开发者提供了C++环境下稳定的异步模型. 综述 基本原理 应用程序与外界交互的方式有很多,可通过文件,网络,串口或控制台.例如在网络通信中,完