
程式文件
任何以書面文字、插圖或影片形式向用戶描述軟體或程式的文字都稱為程式文件或軟體文件。使用者可以是程式設計師、系統分析員、管理員或終端使用者。在開發的不同階段,可能會為不同的使用者建立多個文件。事實上,軟體文件是整個軟體開發過程中至關重要的一個環節。
在模組化程式設計中,文件變得更加重要,因為軟體的不同模組由不同的團隊開發。如果開發團隊以外的任何人想要或需要理解某個模組,良好且詳細的文件將使這項任務更容易。
以下是一些建立文件的指南:
文件應從讀者的角度出發
文件應清晰明確
避免重複
應使用行業標準
文件應始終保持更新
任何過時的文件都應在記錄停用後逐步淘汰
文件的優勢
以下是提供程式文件的一些優勢:
跟蹤軟體或程式的所有部分
更易於維護
開發人員以外的程式設計師可以理解軟體的所有方面
提高軟體的整體質量
輔助使用者培訓
確保知識分散,如果人員突然離開系統,可以降低成本和工作量
示例文件
一個軟體可以有許多型別的相關文件。一些重要的文件包括:
使用者手冊 - 它描述了終端使用者使用軟體不同功能的說明和步驟。
操作手冊 - 它列出並描述了所有正在執行的操作及其相互依賴關係。
設計文件 - 它概述了軟體並詳細描述了設計元素。它記錄了諸如資料流圖、實體關係圖等細節。
需求文件 - 它列出了系統的所有需求以及對需求可行性的分析。它可以包含用例、真實場景等。
技術文件 - 它是對實際程式設計元件(如演算法、流程圖、程式程式碼、功能模組等)的文件記錄。
測試文件 - 它記錄了測試計劃、測試用例、驗證計劃、確認計劃、測試結果等。測試是軟體開發中需要大量文件記錄的一個階段。
已知錯誤列表 - 每個軟體都有一些無法刪除的錯誤或缺陷,因為它們要麼發現得太晚,要麼是無害的,要麼糾正它們需要比必要更多的努力和時間。這些錯誤會與程式文件一起列出,以便以後可以將其移除。它們還可以幫助使用者、實施人員和維護人員在錯誤被啟用時進行處理。