更新時間：2021-06-09 11:00:42作者：admin2
正文如下：
我不知道是不是有人會將閱讀或書寫技術文檔當做愛好。雖然很討厭這樣做，但是通常為了解決問題或介紹一個技術產(chǎn)品，我們不得不去做這些事情。要想寫好文檔很難。技術文檔有幾種形式：基本概覽，高級概覽，一步一步的演示，自動生成的文檔，等等。考慮下不同用戶對你的文檔的需求情況：不同的需求，不同的技術，不同的學習風格。你將會發(fā)現(xiàn)，沒有一種格式能同時適應所有人。受眾情況在寫項目文檔的時候，你首先要考慮到的是讀者。最終用戶首先需要的是一份入門指南。盡管一些技術概念可能會提到，但是重點應放在用戶界面，而不是后臺。如果是程序員，他可能會想得到更多的信息：程序運行原理，代碼的實現(xiàn)，怎樣對代碼進行擴展，等等。為部分用戶寫的文檔不應當影響到另一部分用戶的閱讀，你可以考慮寫兩份單獨的文檔，用戶使用手冊和技術文檔。幾種不同類型的文檔 Jacob Kaplan-Moss在他的怎樣寫好文檔的指南中，他提到了三種文檔：教程，專題指南和參考指南。
教程：教程是很重要的，因為這往往是用戶在使用新的工具時得到的第一印象。我們之前寫到過，有許多不同的工具可以幫你寫好教程。如果你想寫的話，Kaplan-Moss建議你寫得簡單快速一些，但是不要太簡單了，可以做一個演示，為每一步驟添加相關的截圖。專題指南：Kaplan-Moss說這是文檔的主要內容。雖然教程提供了一個高層次的概念，但是專題指南可以讓感興趣的人深入學習，內容一定要詳盡。Kaplan-Moss提到，一般來說，圖書要勝過官方文檔，但是后者的一個優(yōu)點是隨時更新。參考指南：參考指南是為那些已經(jīng)入門但是還需要更多信息的用戶準備的。為那些已經(jīng)知道怎樣使用API，但是需要查找確切的函數(shù)參數(shù)或詳細設置信息的用戶定制的。要指出的是，參考指南是無法由教程和普通指南替代的。自動生成的文檔只能起一個引導作用，如果沒有額外的寫作，編輯和組織，它是不可能解決大家的問題的。雖然這是“技術寫作”，但是這并不意味著你應該放棄文采，語法和拼寫檢查。至少得檢查一下語法和拼寫吧。