如何編寫項目文檔

Question

我剛剛完成了一個相對較小的項目（在幾個模塊中約有3000行代碼），並且我被要求爲項目生成一個文檔。我不知道該怎麼做，因爲我之前主要爲其他程序員編寫代碼。我是否描述每個模塊，爲每個對象做UML圖，簡單地展開我的評論？有我可以使用的模板嗎？如果有人不得不做標準文件，我會很感激你的幫助/指示。

Answer 1

「標準」文檔沒有多少內容; 「Javadoc」風格的API文檔與您近距離接近。獲得更堅實的要求。您的客戶需要什麼類型的文檔？所有類的UML圖是一個整潔的練習，有時候很有用，但是你的時間可能會花在未來的項目上。

Answer 2

最起碼你應該記錄

• 如何構建軟件
• 如何安裝它
• 一個文件和工具的「明顯」的要求
• 發行說明：從什麼改變以前發佈的版本
• 許可和版權信息

然後，根據軟件的使用方式，您可能希望

• 用戶手冊
• API文檔

Answer 3

你可以做得比審查DOD-STD-2178A數據項描述差很多對於軟件設計文檔和版本描述文檔。

SDD描述了軟件的設計。 VDD描述了封裝，包括如何安裝（解包，編譯，加載，設置）。