如何写技术文档

      第一次写博客，想起最近看的一篇文章：如何写技术文档，先拿出来初步练练手

 

1、标题：标题最好能简单明了的表明文章的主要内容

2、分三段描述内容

   2.1  第一段  介绍此技术的背景

   2.2  第二段    介绍技术应用场景

   2.3  第三段    最重要的主题内容：分成三部分：1、介绍   2、代码举例    3、需要讲解 和展开，其中讲解大概需要对每个语法进行分析，每个函数进行讨论和点评，后续对整个结果进行点评    4、展开主要是对实现进行讨论，对实现流程进行讨论，对多种实现方法、每种方法的优劣势进行讨论。

3、对分析的技术做出归纳总结，引用文档，方便读者获取更多信息

 

此文章摘自   github某处，上述按照本人大脑印象引用