怎麼寫軟件文檔
下面的格式你可以參考一下，跟論文差不多的
主要還是要根據你實際編寫的軟件來寫
*************************************
1.引言
1.1編寫目的
1.2項目背景
1.3定義
1.4參考資料
2.2軟件結構
3.程序描述
3.1功能
3.2性能
3.3輸入項目
3.4輸出項目
3.5算法
3.6程序邏輯
3.7接口
3.8存儲分配
3.9限制條件
3.10測試要點
2. 怎樣寫好軟件文檔正文如下：
我不知道是不是有人會將閲讀或書寫技術文檔當**好。雖然很討厭這樣做，但是通常為了解決問題或介紹一個技術產品，我們不得不去做這些事情。要想寫好文檔很難。技術文檔有幾種形式：基本概覽，高級概覽，一步一步的演示，自動生成的文檔，等等。考慮下不同用户對你的文檔的需求情況：不同的需求，不同的技術，不同的學習風格。你將會發現，沒有一種格式能同時適應所有人。受眾情況在寫項目文檔的時候，你首先要考慮到的是讀者。最終用户首先需要的是一份入門指南。儘管一些技術概念可能會提到，但是重點應放在用户界面，而不是後台。如果是程序員，他可能會想得到更多的信息：程序運行原理，代碼的實現，怎樣對代碼進行擴展，等等。為部分用户寫的文檔不應當影響到另一部分用户的閲讀，你可以考慮寫兩份單獨的文檔，用户使用手冊和技術文檔。幾種不同類型的文檔 Jacob Kaplan-Moss在他的怎樣寫好文檔的指南中，他提到了三種文檔：教程，專題指南和參考指南。
教程：教程是很重要的，因為這往往是用户在使用新的工具時得到的第一印象。我們之前寫到過，有許多不同的工具可以幫你寫好教程。如果你想寫的話，Kaplan-Moss建議你寫得簡單快速一些，但是不要太簡單了，可以做一個演示，為每一步驟添加相關的截圖。專題指南：Kaplan-Moss説這是文檔的主要內容。雖然教程提供了一個高層次的概念，但是專題指南可以讓感興趣的人深入學習，內容一定要詳盡。Kaplan-Moss提到，一般來説，圖書要勝過官方文檔，但是後者的一個優點是隨時更新。參考指南：參考指南是為那些已經入門但是還需要更多信息的用户準備的。為那些已經知道怎樣使用API，但是需要查找確切的函數參數或詳細設置信息的用户定製的。要指出的是，參考指南是無法由教程和普通指南替代的。自動生成的文檔只能起一個引導作用，如果沒有額外的寫作，編輯和組織，它是不可能解決大家的問題的。雖然這是“技術寫作”，但是這並不意味着你應該放棄文采，語法和拼寫檢查。至少得檢查一下語法和拼寫吧。
3. 如何寫軟件設計文檔按照以下格式填就好了，不過是我自己寫的，有不好的地方大家互相學習修改一下~
詳細設計文檔規範
1.0概述
這部分提供對整個設計文檔的概述。描述了所有數據，結構，接口和軟件構件級別的設計。
1.1 目標和對象
描述軟件對象的所有目標。
1.2 陳述範圍
軟件描述。主要輸入，過程功能，輸出的描述，不考慮詳細細節。
1.3 軟件內容
軟件被置於商業或者產品線中，討論相關的戰略問題。目的是讓讀者能夠對“宏圖”有所瞭解。
1.4 主要系統參數
任何商務軟件或者產品線都包含軟件規定、設計、實現和測試的説明和規範。
2.0 數據設計
描述所有數據結構包括內部變量，全局變量和臨時數據結構。
2.1 內部軟件數據結構
描述軟件內部的構件之間的數據傳輸的結構。
2.2 全局數據結構
描述主要部分的數據結構。
2.3 臨時數據結構
為臨時應用而生成的文件的描述。
2.4 數據庫描述
作為應用程序的一部分，描述數據庫結構。
3.0 結構化和構件級別設計
描述程序結構。
3.1 程序結構
詳細描述應用程序所選定的程序結構。
3.1.1 結構圖
圖形化描述結構。
3.1.2 選擇性
討論其它可供考慮的結構。選定3.1.1中結構類型的原因。
3.2 構件描述
詳細描述結構中的每個軟件構件。
3.2.1 構件過程敍述（PSPEC）
描述構件的過程。
3.2.2 構件接口描述
詳細描述構件的輸入和輸出。
3.2.3 構件執行細節
每個構件的詳細演算描述。
3.2.3.1 接口描述
3.2.3.2 演算模型（e.g., PDL）
3.2.3.3 規範/限制
]3.2.3.4 本地數據結構
3.2.3.5 在3.2.3.6設計中包含的執行結果
3.3 軟件接口描述
軟件對外界的接口描述
3.3.1機器對外接口
與其他機器或者設備的接口描述。
3.3.2系統對外接口
對其它系統、產品和網絡的接口描述。
3.3.3與人的接口
概述軟件與任何人的界面。
4.0 用户界面設計
描述軟件的用户界面設計。
4.1 描述用户界面
詳細描述用户界面，包括屏幕顯示圖標、圖片或者類型。
4.1.1 屏幕圖片
從用户角度描述界面。
4.1.2 對象和操作
所有屏幕對象和操作的定義。
4.2 界面設計規範
用户界面的設計和實現的規範和標準。
4.3 可見構件
實現的GUI可見構件説明。
4.4 UIDS描述
用户界面開發系統描述。
5.0約束、限制和系統參數
會影響軟件的規格説明、設計和實現的特殊事件。
6.0測試標準
測試策略和預備測試用例描述。
6.1 測試的類別
規定實施測試的類別，包括儘量詳細的描述。這裏是針對黑盒測試現象的描述。
6.2期待軟件反饋
測試期待的結果描述。
6.3執行界線
特殊執行需要的説明。
6.4 重要構件確認
決定性構件或者需要特殊注意的構件的測試確認。
7.0附錄
設計説明的補充信息。
7.1系統可跟蹤矩陣
一個定期迴歸系統規格跟蹤軟件需求的矩陣。
7.2 產品戰略
如果規格説明書是為一個產品設計的，描述相關的產品戰略。
7.3 使用分析算法
描述所有分析活動所使用到的分析算法。
7.4 補充信息 （如果有需要特別説明的）
4. 軟件實施文檔怎麼寫我是從研發步入實施的，研發需要 項目説明書 概要設計文檔 詳細設計文檔 業務模型流程圖
測試需要 測試用例 測試bug文檔 迭代測試問題反饋 測試報告 壓力和性能測試文檔 不過小軟件沒有人做這些壓力和性能測試 ，主要做黑盒測試，就是測試功能完整性。
實施需要 軟件實施環境的需求文檔 軟件實施的工期計劃以及各模塊的具體實施計劃 軟件用户使用手冊，讓用户可以快速上手操作，最好圖文並茂簡單易懂，可以使用wps格式excel格式或者pdf格式，我不太看好ppt，那個真不方便做手冊，希望能幫助你，謝謝！
5. 軟件開發文檔應該如何寫模塊開發卷宗（GB8567——88）
1標題
軟件系統名稱和標識符
模塊名稱和標識符（如果本卷宗包含多於一個的模塊，則用這組模塊的功能標識代替模塊名）
程序編制員簽名
卷宗的修改文本序號
修改完成日期
卷宗序號（説明本卷宗在整個卷宗中的序號）
編排日期（説明整個卷宗最近的一次編排日期）
2模塊開發情況表
3功能説明
扼要説明本模塊（或本組模塊）的功能，主要是輸入、要求的處理、輸出。可以從系統設計説明書中摘錄。同時列出在軟件需求説明書中對這些功能的説明的章、條、款。
4設計説明
説明本模塊（或本組模塊）的設計考慮，包括：
a. 在系統設計説明書中有關對本模塊（或本組模塊）設計考慮的敍述，包括本模塊在軟件系統中所處的層次，它同其他模塊的接口；
b. 在程序設計説明書中有關對本模塊（或本組模塊）的設計考慮，包括本模塊的算法、處理流程、牽涉到的數據文卷設計限制、驅動方式和出錯信息等；
c. 在編制目前已通過全部測試的源代碼時實際使用的設計考慮。
5原代碼清單
要給出所產生的本模塊（或本組模塊）的第一份無語法錯的源代碼清單以及已通過全部測試的當前有效的源代碼清單。
6測試説明
説明直接要經過本模塊（或本組模塊）的每一項測試，包括這些測試各自的標識符和編號、進行這些測試的目的、所用的配置和輸入、預期的輸出及實際的輸出。
7複審的結論
把實際測試的結果，同軟件需求説明書、系統設計説明書、程序設計説明書中規定的要求進行比較和給出結論。
6. 做軟件項目設計文檔怎麼寫啊按照以下格式填就好了，不過是我自己寫的，有不好的地方大家互相學習修改一下~
詳細設計文檔規範
1.0概述
這部分提供對整個設計文檔的概述。描述了所有數據，結構，接口和軟件構件級別的設計。
1.1 目標和對象
描述軟件對象的所有目標。
1.2 陳述範圍
軟件描述。主要輸入，過程功能，輸出的描述，不考慮詳細細節。
1.3 軟件內容
軟件被置於商業或者產品線中，討論相關的戰略問題。目的是讓讀者能夠對“宏圖”有所瞭解。
1.4 主要系統參數
任何商務軟件或者產品線都包含軟件規定、設計、實現和測試的説明和規範。
2.0 數據設計
描述所有數據結構包括內部變量，全局變量和臨時數據結構。
2.1 內部軟件數據結構
描述軟件內部的構件之間的數據傳輸的結構。
2.2 全局數據結構
描述主要部分的數據結構。
2.3 臨時數據結構
為臨時應用而生成的文件的描述。
2.4 數據庫描述
作為應用程序的一部分，描述數據庫結構。
3.0 結構化和構件級別設計
描述程序結構。
3.1 程序結構
詳細描述應用程序所選定的程序結構。
3.1.1 結構圖
圖形化描述結構。
3.1.2 選擇性
討論其它可供考慮的結構。選定3.1.1中結構類型的原因。
3.2 構件描述
詳細描述結構中的每個軟件構件。
3.2.1 構件過程敍述（PSPEC）
描述構件的過程。
3.2.2 構件接口描述
詳細描述構件的輸入和輸出。
3.2.3 構件執行細節
每個構件的詳細演算描述。
3.2.3.1 接口描述
3.2.3.2 演算模型（e.g., PDL）
3.2.3.3 規範/限制
]3.2.3.4 本地數據結構
3.2.3.5 在3.2.3.6設計中包含的執行結果
3.3 軟件接口描述
軟件對外界的接口描述
3.3.1機器對外接口
與其他機器或者設備的接口描述。
3.3.2系統對外接口
對其它系統、產品和網絡的接口描述。
3.3.3與人的接口
概述軟件與任何人的界面。
4.0 用户界面設計
描述軟件的用户界面設計。
4.1 描述用户界面
詳細描述用户界面，包括屏幕顯示圖標、圖片或者類型。
4.1.1 屏幕圖片
從用户角度描述界面。
4.1.2 對象和操作
所有屏幕對象和操作的定義。
4.2 界面設計規範
用户界面的設計和實現的規範和標準。
4.3 可見構件
實現的GUI可見構件説明。
4.4 UIDS描述
用户界面開發系統描述。
5.0約束、限制和系統參數
會影響軟件的規格説明、設計和實現的特殊事件。
6.0測試標準
測試策略和預備測試用例描述。
6.1 測試的類別
規定實施測試的類別，包括儘量詳細的描述。這裏是針對黑盒測試現象的描述。
6.2期待軟件反饋
測試期待的結果描述。
6.3執行界線
特殊執行需要的説明。
6.4 重要構件確認
決定性構件或者需要特殊注意的構件的測試確認。
7.0附錄
設計説明的補充信息。
7.1系統可跟蹤矩陣
一個定期迴歸系統規格跟蹤軟件需求的矩陣。
7.2 產品戰略
如果規格説明書是為一個產品設計的，描述相關的產品戰略。
7.3 使用分析算法
描述所有分析活動所使用到的分析算法。
7.4 補充信息 （如果有需要特別説明的）
7. 軟件開發文檔怎麼寫這要看你的文檔是基於什麼用途的
銷售用途：要有產品白皮書，產品未來方向報告，使用性能報告，兼容性報告，產品演示文稿説明
設計用途的。產品功能需求文件，產品的底層設計，產品詳細設計內容。
產品用途的。產品目錄，自訴文件，幫助文件，使用手冊，產品授權書。
客服用途。已知問題列表，常見問題解答，危機處理指南，問題診斷指南。
有個模板可以看下
國家標準軟件開發文檔模板GB856T
8. 軟件實施文檔怎麼寫我是從研發步入實施的，研發需要 項目説明書 概要設計文檔 詳細設計文檔 業務模型流程圖測試需要 測試用例 測試bug文檔 迭代測試問題反饋 測試報告 壓力和性能測試文檔 不過小軟件沒有人做這些壓力和性能測試 ，主要做黑盒測試，就是測試功能完整性。
實施需要 軟件實施環境的需求文檔 軟件實施的工期計劃以及各模塊的具體實施計劃 軟件用户使用手冊，讓用户可以快速上手操作，最好圖文並茂簡單易懂，可以使用wps格式excel格式或者pdf格式，我不太看好ppt，那個真不方便做手冊，希望能幫助你，謝謝。
