我覺得寫的挺好的，如果讓我寫乙個技術文件，我可能寫的沒有那麼好，關鍵是學習一下寫作結構，我相信只要大的框架對的話，就算語言水平差強人意，同乙個圈子裡面的人也能理解技術文件應該沒有什麼障礙的。
這是阿里的乙個資料視覺化的js庫，這個庫叫g2
看下這個文件的結構，分為5個部分，分別是快速上手、教程、例項、api、更新日誌
現在分析一下為什麼要有這5個部分，技術文件時給技術人員看的，那麼技術人員究竟需要什麼樣的文件呢，換位思考一下，我覺得這樣就離答案不遠了。
先看第乙個部分，快速上手
這個部分主要是介紹了這個庫的概念、特性、安裝方法、乙個簡單的案例，所以綜合一下這幾個小節，快速開始的目的就是讓人了解一下你這個庫是幹什麼用的，給出乙個簡短的概括說明，怎麼用、能實現什麼樣的效果就可以啦，再精簡一下，迅速讓技術人員明白
這個東西能實現啥效果。
使用教程部分給出了這個庫的內建的概念，術語，相當於工具書這麼乙個東西，必不可少。
圖示例項部分給出了各種實現的效果以及原始碼
api部分，就沒啥好說的了，就是提供哪些介面以供呼叫。
更新日誌幫助讀者了解這個庫的歷史以及發展狀況。
（10 3 5）產品需求文件 PRD 的寫作方法
無論我們做什麼事都講究方式方法，寫產品需求文件 以下稱prd文件 也是如此，之前我通過五篇文章分享了自己寫prd文件的一些方法，而這一篇文章主要是對之前五篇文章進行整體的摘要介紹，幫助大家快速了解寫作流程。產品需求文件 prd 的寫作 五篇章 1 寫前準備 資訊結構圖 2 梳理需求 產品結構圖和使用...
產品需求文件 PRD 的寫作方法之筆記一
1.在寫之前，請先很區分清楚什麼是mrd文件 市場需求文件 brd文件 商業需求文件 什麼是prd文件 產品需求文件 可查閱知乎 2.規劃產品的思維導圖 資訊結構圖 在寫作這份文件前，我們需要先做一些準備，把brd mrd的相關需求消化並融合規劃出產品的結構圖。因為這些準備工作是屬於思維類的，所以我...
阮一峰 中文技術文件的寫作規範
很多人說，不知道怎麼寫文件，都是憑著感覺寫。網上也很少有資料，教你寫文件。這已經影響了中文軟體的發展。我就動手，參考上面的規範，也結合自己的實踐，總結了乙份簡單的 中文技術文件的寫作規範 標題文字 段落數值 標點符號 章節結構 下面是關於寫作風格的乙個片段。歡迎提交 issue 和 pr 補充。寫作...