关于写技术文档这件事

关于写技术文档这件事

最近快两个月的时间，一直在写项目申报书。虽然具体技术荒废了不少，但最起码有亮点好处，一是扩宽了眼界，二是写作水平的提高。第二点便是这篇文章的主题，聊聊关于如何写技术文档的一些技巧以及自己的一些感悟。

1 对待技术

​ 第一点感悟——对待技术要认真

​ 在写申报书的过程中，设计到的各种各样的技术，从访问控制到深度学习。想要明白所有的技术细节需要耗费大量的功夫。因此，我一开始写文档的时候不免偷懒，把综述中的文字直接搬过来就用了。长久以来，自己也不知道写出了什么东西，文档本身的针对性差，阅读性也差。

​ 在这里需要强调的是，对待技术一定要有一个认真的态度。自己首先要搞清楚这项技术是怎么回事，才能在文档中给别人说清楚。

​ 总之，带着自己的思考去写。

2 如何描述一个具体技术

​ 做到了第一点，认真对待技术之后，对于这项技术有了自己的理解之后，就要说说怎么样把技术讲清楚这件事了。

​ 大概可以分为以下几个步骤

• 分析当前问题

• 说明该技术可以解决该问题

• 该技术和其他解决方法之间的区别是什么，该技术的优势是什么，缺点是什么

• 该技术的原理

  这几个步骤，并不一定要按照顺序来，只要头脑中有着明确的逻辑思路就可以，不过这几个环节一般都需要说清楚。

3 如何写自己的专长

​ 在写专长（技术特点）的时候，得到了老板的指导，说的很精辟，我就直接把原话整出来吧。

​ 在写亮点的时候，应该这样写：在这一块有问题，该问题很严重，别人解决不了这个问题，我们能解决这个问题.

​

​