從事互聯(lián)網(wǎng)行業(yè)或者技術(shù)行業(yè)的人來說，撰寫技術(shù)文檔這項(xiàng)工作肯定不陌生。但如何撰寫技術(shù)文檔呢？我從我的角度來總結(jié)一下，認(rèn)為一篇好的技術(shù)文檔需要達(dá)到以下幾點(diǎn)要求。

通俗易懂

第一點(diǎn)不用多說，寫一篇技術(shù)文檔的目的就是讓其他開發(fā)者或使用者能夠了解你發(fā)開項(xiàng)目的內(nèi)容。因此，通俗易懂在我看來是一篇技術(shù)文檔最重要的要求。在我看來，如果一個(gè)用戶在沒有看到程序或代碼之前，僅憑技術(shù)文檔就能夠了解程序的所有內(nèi)容就是一篇好的技術(shù)文檔。

輕易上手

通過閱讀技術(shù)文檔，使用者和開發(fā)者下一步就是使用你寫的程序或代碼框架。一篇好的技術(shù)文檔，應(yīng)該有幫助用戶快速上手了解程序的實(shí)例，如果是比較龐雜的程序或框架，應(yīng)該對(duì)每個(gè)輕耦合的內(nèi)容進(jìn)行編寫demo，以便使用者或開發(fā)者加以了解。

查找方便

當(dāng)開發(fā)者在使用程序出現(xiàn)疑惑查找技術(shù)文檔時(shí)，一篇好的技術(shù)文檔應(yīng)該便于查找。當(dāng)我們第一次翻閱技術(shù)文檔時(shí)，可能對(duì)于一個(gè)技術(shù)細(xì)節(jié)，能夠在技術(shù)文檔中多出重復(fù)看到，這可能并不是撰寫技術(shù)文檔的人為了湊字?jǐn)?shù)，而是方便我們?nèi)蘸蟛檎椅臋n時(shí)，能夠在翻閱不同內(nèi)容時(shí)，查詢到內(nèi)容的完整性。

結(jié)構(gòu)完整

結(jié)構(gòu)完整在我看來也算是一篇好的技術(shù)文檔該有的要求。一篇技術(shù)文檔主要包括標(biāo)題、文本、段落、圖片、表格。在撰寫這幾個(gè)部分時(shí)，應(yīng)該對(duì)它們自身也編寫完整。例如，一篇技術(shù)文檔中的圖表是能夠自成體系的，用戶通過僅看圖表和圖注，也能獲取到一個(gè)完整的信息。

其他要求

除了以上四點(diǎn)要求，一篇好的技術(shù)文檔當(dāng)然還有其他優(yōu)點(diǎn)，比如語義準(zhǔn)確、用詞規(guī)范等等，這些也非常重要。