今日事今日毕

今日事今日毕，很老套的语言，但却印证了一句古话，最难懂的道理是最简单最平凡的道理！

 

最近写中期报告，需要将以前做过的东西总结一遍。做过的东西要留下文档，这个道理已经听过无数遍了，

从入实验室 的第一天，受这句话的影响，每天做的事情基本都作了一个小结，短短的写了几句，现在回

过头来去看那些东西，却发现还是得从从头开始，基本上没有什么印象了。这不是个好现象，知识需要积累

需要转化为认识和能力，转化为可以转化的成果。即便当时做出东西来了，但那并不代表你完全掌握了它

并不代表这个东西就没有问题，时间一长可能你又不明白是怎么回事了，也可能出现新的问题，这个时候

想要做点事情，你基本上还是得从头再来。没文档不如有文档，或许有人会这样说！ 但是不全的文档，错误

百出的文档可能还会误导后来的人和事。以后做过的工作务必留下详细的文档！

 

问题是：什么样的文档才是合格的文档呢？ 怎么样才能写出好的文档呢？

当我们看文档的时候，我们大部分情况下是对我们所需要知道的东西基本不了解的，和一个外行差不多，

有了这个假定，我们需要考虑的问题基本也就定型了。

 

对自己写的文档的要求：

1 原理要清楚明了，该有图就有图，该有公式就有公式，这是一个抽象层次的东西。如果涉及到一些认识

前提，必要情况下需要注明出处，做到思路清晰，有理有据，有稽可查。

2 实现，大概框架

3 细节，说明性的东西，该注意的问题

说白了就是写给白痴（包括自己）看的。

 

可能做这个事情的时候会觉得多次一举，花那么多的功夫这么做有点不值，但要想积累为可具体化的成果，

似拙而智！舍此无他！飞过了就一定要留下痕迹！否则自己都不知道来过。

md，怪不得老外的书都那么厚一本！