軟體工程筆記之 – 另外一面

需要什麼樣的文檔

1．  目的。主要功能，開發原因。

2．  環境。

3．  範圍。輸入的有效範圍是什麼

4．  實現功能和使用的演算法。

5．  輸入，輸出格式。

6．  操作指令。

7．  選項

8．  已耗用時間

9．  精度和校正

流程圖

       流程圖不應該過於吹捧，它只是體現軟體邏輯結構的一種手段，並且盡量畫它在一頁紙上。逐一記錄的詳細流程圖過時而且令人生厭，它只適合啟蒙初學者的演算法思維。

自文檔化的程式

       文檔的解決方案是“合并檔案”，即把文檔整合到來源程式。這對正確的維護是直接有力的推動，保證編程使用者能方便、及時地得到文檔資料。這種程式被稱著自文檔化。

       現在看來在文檔中保含流程圖是一種笨拙的做法。考慮到流程圖方法的落後和進階語言的使用占統治地位，把程式和文檔放在一起顯然是很合理的。