教學軟體使用文件是為了幫助使用者理解該教育軟體的目標、作用、意義和使用方法而必備的文件資料，應隨程式一起發至使用者。文件的編寫可分為功能簡介和使用說明書兩部分。其內容按以下要求編寫：
一、功能簡介
1. 軟體名稱及其版本號
2. 開發者
3. 載體
載體形式（磁碟／磁帶／光碟及其規格等）；載體卷數。
4. 教育目標
預定達到的教育目標，包括過程性目標（子目標），應盡可能詳盡。
5. 適用範圍及物件
適用學生年齡、年級、認知能力、水平層次等。
6. 硬體支撐環境要求
執行該軟體所需要的計算機種類、型號、外設配置、記憶體最低容量等。
7. 軟體支撐環境要求
執行該軟體所需要的軟體支援。例如作業系統的型別、版本號、漢字輸入系統的名稱及版本等。
8. 功能特點
該軟體的各項功能及子功能，使用該軟體於教學活動的主要特點。例如，學生學習程序管理、練習題目隨機產生，判斷反饋有針對性等等。
9. 應用建議
對該軟體用於教學活動時使用方法的建議。如：主要用於示教；主要用於個人操練；主要用於**後組織課堂討論等。
10. 參考資料
二、使用說明書
軟體的使用方法要從下述五個方面加以說明。
1. 安裝與初始化方法
描述把軟體安裝到計算機上的會話過程和初始化過程。必要時用螢幕圖示來表達。
2. 啟動方法
啟動命令及其引數；啟動的會話過程。
3. 操作
使用者所能使用的各功能項的操作命令、操作方法與操作過程。
人機會話格式：軟體如何等待使用者輸入；輸入資料的格式（語法規則、長度、順序、標點、預設等資訊的約定）、所用各種鍵的意義與作用等。
退出、中斷、返回上級功能項（或主功能項）的方法。
以上應分別給以必要的例項解釋。
4. 錯誤處理
說明各種可能產生的錯誤、產生錯誤的原因及對使用者處理這些錯誤的建議。
5. 輸出資訊
列出所有輸出資訊及相應的解釋。
軟體文件編寫那些事
對於文件的編寫，你了解多少呢？下面描述了一些我不知道的問題，看看你知道嗎？一 總體來說，每乙個文件在目錄和引言之間，都要有乙個變更記錄表 當然，變更記錄表的形式不固定，可以自己設計，但是主要的幾項不能丟掉，如 修改記錄，變更時間，修改人，驗收人 等。在文件的編寫時，你的文件標題是 系統設計文件嗎 還...
計算機軟體開發文件編寫指南
一 可行性研究報告 二 專案開發計畫 三 需求規格說明書 四 概要設計說明書 五 詳細設計說明書 六 使用者操作手冊 七 測試計畫 八 測試分析報告 九 開發進度月報 十 專案開發總結報告 十一 程式維護手冊 十二 軟體問題報告 十三 軟體修改報告 一 可行性研究報告 1.引言 1.1編寫目的 1....
使用Sphinx編寫文件
作業系統 windows7 x64 python 版本 2.7.10 sphinx 版本 使用pip安裝 pip install u sphinx pip install sphinx rtd theme 從原始碼安裝 在控制台輸入以下命令 sphinx quickstart 根據實際情況填寫。in...