人月神話閱讀筆記03

不一樣用戶須要不一樣級別的文檔。某些用戶僅僅偶爾使用程序，有些用戶必須依賴程序，還有一些用戶必須根據環境和目的的變更對程序進行修改。在須要什麼樣的文檔一段從使用程序，驗證程序和修改程序三個方面來談如何寫文檔，文檔內容應該包含哪些核心要素。使用程序方面的文檔發生在程序編寫前，要描述清楚程序的目的，範圍，場景，輸入，輸出等各項重要內容。每個發佈的程序須要附加驗證說明，即準備咱們常作的測試用例，這個發生在驗證測試階段。最後，調整程序或者修復程序須要更多的信息。顯然，這要求瞭解所有的細節，而且這些細節已經記錄在註釋良好的列表中。

流程圖是被吹捧得最過度的一種程序文檔。事實上，不少程序甚至不須要流程圖，不多有程序須要一頁紙以上的流程圖。現實中，流程圖被鼓吹的程度遠大於它們的實際做用。