• <nav id="8m6ki"></nav>
  • 新聞動態

      當前位置: 首頁  新聞動態 >

    為什么我們要寫軟件開發文檔

    為什么文檔是軟件開發中的一部分?

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

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

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

    對于一些匿名的軟件作品,如果存在 “簡約” 的文檔,當我們看到這個文檔會不禁謾罵,因為即使是一個設計卓越的產品,如果沒有完善的文檔,對于用戶來說,可能是無法延長其生命周期的。

    所以對于軟件編程產品面向計算機的代碼和面向用戶的文檔是同等重要的,我們克服我們的惰性和壓力,堅持完善文檔。

    文檔應該怎么寫?

    文檔大致可以分為三類:

    - 使用人員

    這部分文檔通常要說明軟件應該怎么操作,最終達到什么目的,大多是從交互的層面進行軟件可以做什么,怎么操作,通常采用說明,和圖文并茂的形式進行書寫。

    - 驗收人員

    這部分人通常拿到這個可用的軟件之后,要保證這個軟件是可用的,什么才是可用的呢?

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

    1. 準備一組正常的數據,通過跟軟件交互進行驗證,在正常操作下,軟件是可用的。

    2. 準備一些邊界數據,在輸入的情況下,能夠合理的提示或者引導用戶,進行合法的提示。

    3. 準備一組異常的數據,或者不符合要求的輸入。在這種情況保證軟件不會崩潰。

    - 修改人員

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

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

    2. 接口文檔,以及重要或者復雜業務邏輯的流程圖。

    3. 代碼(清晰的代碼邏輯結構,完善的測試用例,以及文件標題以及函數內部應有的注釋都是非常重要的。)


    配资比例多少属于合法
  • <nav id="8m6ki"></nav>