如何寫技術文檔

      第一次寫博客，想起最近看的一篇文章：如何寫技術文檔，先拿出來初步練練手

 

一、標題：標題最好能簡單明瞭的代表文章的主要內容

二、分三段描述內容

   2.1  第一段  介紹此技術的背景

   2.2  第二段    介紹技術應用場景

   2.3  第三段    最重要的主題內容：分紅三部分：一、介紹   二、代碼舉例    三、須要講解 和展開，其中講解大概須要對每一個語法進行分析，每一個函數進行討論和點評，後續對整個結果進行點評    四、展開主要是對實現進行討論，對實現流程進行討論，對多種實現方法、每種方法的優劣勢進行討論。

三、對分析的技術作出概括總結，引用文檔，方便讀者獲取更多信息

 

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