為什麼我們要寫軟體開發文件

為什麼文件是軟體開發中的一部分？

計算機本身能夠執行符合邏輯的指令，我們在開發過程中只要按照嚴格的語法和嚴謹的定義編寫**，那麼計算機就能夠執行。但是程式能夠執行就完事了嗎？在軟體行業流行這樣一句話，**是讓人看的，機器只是順便執行下。

我們在編寫**之前或者在編寫**過程中，甚至若干個迭代後，文件都是必不可少的，即使你寫的軟體是給自己用的，也不例外，因為記憶的衰退會導致人-作者失去對程式的了解，你不得不重試你勞動的各個細節，浪費很多不必要的時間。

對於公用的軟體，我們通常會遠離軟體的作者，對於這類軟體，文件本身的重要性，更是不言而喻了。

對於一些匿名的軟體作品，如果存在「簡約」的文件，當我們看到這個文件會不禁謾罵，因為即使是乙個設計卓越的產品，如果沒有完善的文件，對於使用者來說，可能是無法延長其生命週期的。

所以對於軟體程式設計產品面向計算機的**和面向使用者的文件是同等重要的，我們克服我們的惰性和壓力，堅持完善文件。

文件應該怎麼寫？

文件大致可以分為三類：

- 使用人員

這部分文件通常要說明軟體應該怎麼操作，最終達到什麼目的，大多是從互動的層面進行軟體可以做什麼，怎麼操作，通常採用說明，和**並茂的形式進行書寫。

- 驗收人員

這部分人通常拿到這個可用的軟體之後，要保證這個軟體是可用的，什麼才是可用的呢？

通常我們需要準備以下三個方面進行驗證軟體的可用性。

1. 準備一組正常的資料，通過跟軟體互動進行驗證，在正常操作下，軟體是可用的。

2. 準備一些邊界資料，在輸入的情況下，能夠合理的提示或者引導使用者，進行合法的提示。

3. 準備一組異常的資料，或者不符合要求的輸入。在這種情況保證軟體不會崩潰。

- 修改人員

通常這部分人對軟體的認知程度，相比上面兩種要更加深入，因為他要肩負著修改和定製軟體內部業務邏輯。對於這一部分人我們在文件中說明以下部分：

1. 需求文件，軟體的開發背景，需求分析，框架等文件。

2. 介面文件，以及重要或者複雜業務邏輯的流程圖。

3. **（清晰的**邏輯結構，完善的測試用例，以及檔案標題以及函式內部應有的注釋都是非常重要的。）