Documentation

💻 IGCSE ICT 綜合學習筆記：系統文件 (系統生命週期第 7.5 節)

你好！歡迎來到系統生命週期旅程的最後一站。你已經完成了一個新系統的分析、設計、測試和實施。但是，等等——使用者該如何操作它？未來的工程師又該如何維護它？這就是系統文件 (Documentation) 發揮作用的時候了！

在本章中，我們將學習為何優質的文件如此關鍵，並深入探討兩種類型的文件：為 IT 專家準備的詳細「藍圖」（技術文件），以及為用戶準備的友善「說明手冊」（用戶文件）。

📜 7.5 什麼是系統文件？

系統文件是指用於解釋 ICT 系統如何運作、如何構建以及應如何使用的書面說明、指引和指南。

想像一下你在組裝一個大型樂高城堡：你需要簡單的圖片說明書（用戶文件）來完成組裝；但如果你需要擴建城堡或更換遺失零件時，你則需要一份詳細記錄了每一塊積木和連接件的清單（技術文件）。

你需要掌握兩大類型的系統文件：

• 技術文件 (Technical Documentation)（面向 IT 專業人員）
• 用戶文件 (User Documentation)（面向實際使用系統的人員）

重點總結：系統文件確保了系統在原開發者離開後，依然能夠被順利使用、維護和修改。

📝 第一節：技術文件 (開發者手冊)

技術文件（通常稱為系統文檔）是為負責管理、維護和修改系統的人員所編寫的。這些人員包括原始程式設計師、系統分析師以及未來的 IT 支援人員。

技術文件的目的

其主要目標是提供足夠詳盡的資訊，讓一位從未接觸過該系統的 IT 專業人員，也能理解系統各部分的結構與運作方式。

• 協助 IT 人員維護系統（保持系統穩定運作）。
• 讓開發人員能夠輕鬆地進行除錯 (Debug)（修復錯誤）或修改（添加新功能）。
• 確保系統在整個生命週期內保持一致性和品質。

💪 技術文件的關鍵組成部分

這部分內容較為細緻，我們來詳細拆解其中必須包含的內容：

1. 系統概覽與需求

• 系統/程式目的：明確說明軟件旨在實現的目標（例如：「該系統用於管理庫存並實現自動化補貨」。）。
• 系統限制：說明系統無法做到的事情（例如：「系統只能處理 10,000 條活躍記錄」或「它無法計算稅務」。）。
• 硬件與軟件需求：運行和維護該軟件所需的最低電腦配備（CPU、RAM、儲存空間）及作業系統/工具程式清單。

2. 設計與邏輯

• 系統流程圖：視覺化圖表，展示數據如何在整個系統及其各個程序中流動。
• 程式流程圖/演算法：展示個別程式或模組內部邏輯的詳細圖表或逐步說明。

3. 數據結構與驗證

• 檔案結構：數據組織方式的詳細資訊，包括資料表名稱、關聯性及索引鍵（如主鍵 Primary Keys）。
• 變數清單：詞彙表，列出所有使用的變數，解釋其名稱、數據類型（如整數 Integer、文字 Text、布林值 Boolean）及用途。
• 輸入與輸出格式：描述或圖表，明確展示輸入的數據格式（數據採集表格）以及最終結果的顯示方式（報表佈局）。
• 驗證程序：應用於輸入數據的具體規則（例如：範圍檢查 Range check、長度檢查 Length check、校對碼 Check digit）。

4. 測試資訊

• 樣本測試/測試執行：測試數據的範例，展示測試過程中預期的結果以及實際記錄到的結果。

📖 第二節：用戶文件 (說明手冊)

用戶文件是為終端用戶 (End-user)設計的，也就是每天使用該軟件來執行工作的員工。這份文件必須易於閱讀，避免使用專業術語，並專注於實際的操作步驟。

別擔心！如果一開始覺得很難寫，請記住最關鍵的差異在於「受眾」。如果你的媽媽或年幼的弟弟妹妹能夠根據這些說明來操作軟件，那就是一份出色的用戶文件！

用戶文件的目的

其主要目標是確保用戶能夠在無需持續向 IT 部門求助的情況下，自信且有效地操作系統。

• 解釋如何操作軟件（逐步指引）。
• 在用戶遇到錯誤或困難時提供協助。
• 以簡單易懂的方式介紹系統功能。

💪 用戶文件的關鍵組成部分

用戶文件可以透過不同形式提供，例如紙本手冊、軟件內的輔助檔案，或網站/Wiki 頁面。

1. 入門指南

• 系統目的：簡單解釋該系統的功能。
• 系統限制：用戶可以預期什麼，以及系統無法處理什麼。
• 硬件與軟件需求：運行軟件所需的快速參考清單。
• 如何載入/運行/安裝軟件：設置和啟動程式的逐步說明。

2. 操作指南 (How-Tos)

• 如何儲存檔案或列印資料：與數據互動的基本必要說明。
• 如何新增/刪除/編輯記錄：詳細的編號步驟，展示用戶如何處理他們負責的數據。
• 輸入與輸出格式：範例或螢幕截圖，展示數據採集表格的樣式以及預期看到的報表。
• 樣本執行：簡單範例，顯示當特定任務成功完成時，螢幕應呈現的樣貌。

3. 處理問題

• 錯誤訊息與處理：常見錯誤訊息清單（例如：「輸入的數據無效」）以及修復問題的明確指示。
• 疑難排解指南/熱線：專門解決常見問題的章節，通常包含支援聯繫資訊。
• 常見問題集 (FAQs)：對用戶常問問題的解答。
• 詞彙表：對軟件中使用的特定專業術語進行簡單定義（例如：「查詢 Query」是什麼意思？）。

📌 技術文件與用戶文件比較

考試中經常會要求你比較這兩類文件，或說明為什麼某些組成部分需要包含在其中一種文件，而不必包含在另一種。以下是關鍵差異：

技術文件 vs. 用戶文件（快速比較）

• 技術文件： 專注於「它是如何構建的？」
  範例內容： 程式語言、檔案結構、流程圖。
• 用戶文件： 專注於「我該如何使用它？」
  範例內容： 如何列印、疑難排解指南、常見問題集。

你知道嗎？ 許多現代公司正逐漸淘汰傳統的紙本手冊，改用「情境相關協助」(context-sensitive help)。當你按下 F1 鍵或點擊問號按鈕時，系統會立即顯示與你當前畫面相關的文件說明。這在用戶文件中非常受歡迎！

***

最終重點總結

系統文件是開發團隊與真實世界之間的關鍵連結。好的文件能節省時間、金錢並減少挫折感。在回答考試題目時，請務必先辨識目標對象——是程式設計師還是普通用戶？這將能讓你判斷哪些組成部分才是最相關的。