建立良好的文档习惯 - 专家教你如何成为一名优秀的工程师

　　建立良好的文档习惯

　　知识在于积累，但是人的记忆如果不经常刷新是会容易遗忘的，和DRAM一个道理。因此如果不能定期刷新，那么请把经验都写下来，成为一个本，通过各种网络渠道存放起来，以便随时翻查，这是“云硬盘”的一个最好的用法之一。

　　作为一个软件工程师，自己的代码风格的确自己很熟悉，所以写代码的时候很多时候不写注释，出现很多魔鬼数字，到处随便定义变量，但是如果这样的话不利于程序的维护以及传承。举个例子，一个ARM的linux程序，用以下定义，是否比在文档内嵌代码强呢？

　　随时备份自己的程序，编号以及时间戳做好。虽然软件上面有很多很好用的工具，我相信大部分工程师都不会使用这些代码维护工具。那么请看下个建议

　　软件/硬件的框架的制定以及描述文档的建立。建立了这些文档，可以让自己不断的对自己的思维/想法进行纠正，这样的话对自己的提升有很大帮助。

　　工欲善其事必先利其器

　　首先要做好一件事情，必须首先把工具搞好，比如FPGA开发，必须把开发环境搭建起来，如何进行验证以及代码编写等，环境搭建有很多方法，要么找厂家FAE索取相关的经验，要么找资深工程师进行咨询。

　　使用的工具正确的话，那么有时候事半功倍，好比上面截图的代码工具名字叫source insight，这个工具的功能强大，对于代码分析能提高很多的效率。这些如果写成了开发文档，那么就是经验了，这些经验有时候对于菜鸟来说，就是一本圣经，能够缩短成为老鸟的时间。

　　建立良好的思维习惯

　　作为嵌入式软件工程师，和ARM/单片机打交道超过10年，个人最反对的是使用debugger，除非特殊的纯软件算法，否则在很多混合场合是无法使用 debugger的，因为很多实时的信号过了就没有了，等你停下来找原因，黄花菜都凉了。良好严谨的思维方式，可以让自己在碰到某些情况的时候迅速定位问题所在解决问题，而不是依靠debugger进行辅助设计。

　　结构化的代码，软件为主的一个思想，这是很重要的指导思想。没有哪个公司能够把东西一步到位，所以写程序不要认为你可以完全，连Microsoft都平均2年一个操作系统，何况我们作为IT人士，难道指望一个程序能活5年？因此程序要把自己的定位做好，别做万金油，万金油包治百病，但实际都不能根治。