我覺得寫的挺好的，如果讓我寫一個技術文檔，我可能寫的沒有那么好，關鍵是學習一下寫作結構，我相信只要大的框架對的話，就算語言水平差強人意，同一個圈子里面的人也能理解技術文檔應該沒有什么障礙的。
https://antv.alipay.com/g2/doc/index.html
這是阿里的一個數據可視化的js庫，這個庫叫G2
看下這個文檔的結構，分為5個部分，分別是快速上手、教程、實例、API、更新日志
現在分析一下為什么要有這5個部分，技術文檔時給技術人員看的，那么技術人員究竟需要什么樣的文檔呢，換位思考一下，我覺得這樣就離答案不遠了。
先看第一個部分，快速上手
這個部分主要是介紹了這個庫的概念、特性、安裝方法、一個簡單的案例，所以綜合一下這幾個小節，快速開始的目的就是讓人了解一下你這個庫是干什么用的，給出一個簡短的概括說明，怎么用、能實現什么樣的效果就可以啦，再精簡一下，迅速讓技術人員明白
這個東西能實現啥效果。
使用教程部分給出了這個庫的內置的概念，術語，相當於工具書這么一個東西，必不可少。
圖標實例部分給出了各種實現的效果以及源碼
API部分，就沒啥好說的了，就是提供哪些接口以供調用。
更新日志幫助讀者了解這個庫的歷史以及發展狀況。