❶ 申請計算機軟體著作權時 需要提供軟體使用說明書 這個說明書友有什麼要求 有固定的模板嗎
軟體使用說明書並沒有固定的模板,但一定要圖文並茂,文字描述詳細准確,對軟體的功能模塊描述清楚即可。軟體使用說明書中出現的任何文件一定要和申請書中出現的全稱及簡稱名稱一致,切記不可出現其他軟體名稱,建議頁數在15頁左右。此外,還有以下幾點需要注意:
1、不是只能提供使用手冊,也可以提供設計手冊。
2、文檔頁眉上應當標注該申請軟體名稱、版本號,並應當與申請表中相應內容完全一致,右上角應標注頁碼,文檔每頁不少於30行,有圖除外。
3、內容不能太簡單請盡量提供完整的文檔將軟體的操作介紹完整。
4、文檔中出現的版權信息應當與申請信息完全一致。
5、文檔中出現的軟體名稱應當與申請的完全一致。
6、其他根據實際情況應該注意的問題。
(1)程序說明書模板擴展閱讀:
《計算機軟體保護條例》
第九條 申請軟體著作權登記的,應當向中國版權保護中心提交以下材料:
(一)按要求填寫的軟體著作權登記申請表。
(二)軟體的鑒別材料。
(三)相關的證明文件。
第十條 軟體的鑒別材料包括程序和文檔的鑒別材料。
程序和文檔的鑒別材料應當由源程序和任何一種文檔前、後各連續30頁組成。整個程序和文檔不到60頁的,應當提交整個源程序和文檔。除特定情況外,程序每頁不少於50行,文檔每頁不少於30行。
第十一條 申請軟體著作權登記的,應當提交以下主要證明文件:
(一)自然人、法人或者其他組織的身份證明。
(二)有著作權歸屬書面合同或者項目任務書的,應當提交合同或者項目任務書。
(三)經原軟體著作權人許可,在原有軟體上開發的軟體,應當提交原著作權人的許可證明。
(四)權利繼承人、受讓人或者承受人,提交權利繼承、受讓或者承受的證明。
第十二條 申請軟體著作權登記的,可以選擇以下方式之一對鑒別材料作例外交存:
(一)源程序的前、後各連續的30頁,其中的機密部分用黑色寬斜線覆蓋,但覆蓋部分不得超過交存源程序的50%。
(二)源程序連續的前10頁,加上源程序的任何部分的連續的50頁。
(三)目標程序的前、後各連續的30頁,加上源程序的任何部分的連續的20頁。
文檔作例外交存的,參照前款規定處理。
❷ java企業軟體開發設計說明書如何做
1、組織與風格(1).關鍵詞和操作符之間加適當的空格。(2).相對獨立的程序塊與塊之間加空行(3).較長的語句、表達式等要分成多行書寫。(4).劃分出的新行要進行適應的縮進,使排版整齊,語句可讀。(5).長表達式要在低優先順序操作符處劃分新行,操作符放在新行之首。(6).循環、判斷等語句中若有較長的表達式或語句,則要進行適應的劃分。(7).若函數或過程中的參數較長,則要進行適當的劃分。(8).不允許把多個短語句寫在一行中,即一行只寫一條語句。(9).函數或過程的開始、結構的定義及循環、判斷等語句中的代碼都要採用縮進風格。註:如果大家有興趣可以到安安DIY創作室博客,有相關說明性的文章和解釋。2、註解Java 的語法與 C++ 及為相似,那麼,你知道 Java 的注釋有幾種嗎?是兩種?// 注釋一行/* ...... */ 注釋若干行不完全對,除了以上兩種之外,還有第三種,文檔注釋:/** ...... */ 注釋若干行,並寫入 javadoc 文檔注釋要簡單明了。String userName = null; //用戶名邊寫代碼邊注釋,修改代碼同時修改相應的注釋,以保證注釋與代碼的一致性。在必要的地方注釋,注釋量要適中。注釋的內容要清楚、明了,含義准確,防止注釋二義性。保持注釋與其描述的代碼相鄰,即注釋的就近原則。對代碼的注釋應放在其上方相鄰位置,不可放在下面。對數據結構的注釋應放在其上方相鄰位置,不可放在下面;對結構中的每個域的注釋應放在此域的右方;同一結構中不同域的注釋要對齊。變數、常量的注釋應放在其上方相鄰位置或右方。全局變數要有較詳細的注釋,包括對其功能、取值范圍、哪些函數或過程存取它以及存取時注意事項等的說明。在每個源文件的頭部要有必要的注釋信息,包括:文件名;版本號;作者;生成日期;模塊功能描述(如功能、主要演算法、內部各部分之間的關系、該文件與其它文件關系等);主要函數或過程清單及本文件歷史修改記錄等。/*** Copy Right Information : Neusoft IIT* Project : eTrain* JDK version used : jdk1.3.1* Comments : config path* Version : 1.01* Modification history :2003.5.1* Sr Date Modified By Why & What is modified* 1. 2003.5.2 Kevin Gao new**/在每個函數或過程的前面要有必要的注釋信息,包括:函數或過程名稱;功能描述;輸入、輸出及返回值說明;調用關系及被調用關系說明等/*** Description :checkout 提款* @param Hashtable cart info* @param OrderBean order info* @return String*/public String checkout(Hashtable htCart,OrderBean orderBean)throws Exception{}javadoc注釋標簽語法@author 對類的說明 標明開發該類模塊的作者@version 對類的說明 標明該類模塊的版本@see 對類、屬性、方法的說明 參考轉向,也就是相關主題@param 對方法的說明 對方法中某參數的說明@return 對方法的說明 對方法返回值的說明@exception 對方法的說明 對方法可能拋出的異常進行說明3、命名規范定義這個規范的目的是讓項目中所有的文檔都看起來像一個人寫的,增加可讀性,減少項目組中因為換人而帶來的損失。(這些規范並不是一定要絕對遵守,但是一定要讓程序有良好的可讀性)較短的單詞可通過去掉母音形成縮寫;要不然最後自己寫的代碼自己都看不懂了,那可不行。較長的單詞可取單詞的頭幾發符的優先順序,並用括弧明確表達式的操作順序,避免使用默認優先順序。使用匈牙利表示法Package 的命名Package 的名字應該都是由一個小寫單片語成。package com.neu.utilClass 的命名Class 的名字必須由大寫字母開頭而其他字母都小寫的單片語成,對於所有標識符,其中包含的所有單詞都應緊靠在一起,而且大寫中間單詞的首字母。public class ThisAClassName{}Class 變數的命名變數的名字必須用一個小寫字母開頭。後面的單詞用大寫字母開頭userName , thisAClassMethodStatic Final 變數的命名static Final 變數的名字應該都大寫,並且指出完整含義。/***DBConfig PATH**/public static final StringDB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig;參數的命名參數的名字必須和變數的命名規范一致。數組的命名數組應該總是用下面的方式來命名:byte[] buffer;而不是:byte buffer[];方法的參數使用有意義的參數命名,如果可能的話,使用和要賦值的欄位一樣的名字:SetCounter(int size){this.size = size;}4、文件樣式所有的 Java(*.java) 文件都必須遵守如下的樣式規則:版權信息版權信息必須在 java 文件的開頭,比如:/** Copyright ? 2000 Shanghai XXX Co. Ltd.* All right reserved.*/其他不需要出現在 javadoc 的信息也可以包含在這里。Package/Importspackage 行要在 import 行之前,import 中標準的包名要在本地的包名之前,而且按照字母順序排列。如果 import 行中包含了同一個包中的不同子目錄,則應該用 * 來處理。package hotlava.net.stats;import java io.*;import java.util.Observable;import hotlava.util.Application;這里 java。io.* 使用來代替InputStream and OutputStream 的。Class接下來的是類的注釋,一般是用來解釋類的。/*** A class representing a set of packet and byte counters* It is observable to allow it to be watched, but only* reports changes when the current set is complete*/接下來是類定義,包含了在不同的行的 extends 和 implementspublic class CounterSetextends Observableimplements CloneableClass Fields接下來是類的成員變數:/*** Packet counters*/protected int[] packets;public 的成員變數必須生成文檔(JavaDoc)。proceted、private和 package 定義的成員變數如果名字含義明確的話,可以沒有注釋。存取方法接下來是類變數的存取的方法。它只是簡單的用來將類的變數賦值獲取值的話,可以簡單的寫在一行上。/*** Get the counters* @return an array containing the statistical data. This array has been* freshly allocated and can be modified by the caller.*/public int[] getPackets() { return Array(packets, offset); }public int[] getBytes() { return Array(bytes, offset); }public int[] getPackets() { return packets; }public void setPackets(int[] packets) { this.packets = packets; }其它的方法不要寫在一行上構造函數接下來是構造函數,它應該用遞增的方式寫(比如:參數多的寫在後面)。訪問類型 (public, private 等.) 和 任何 static, final 或 synchronized 應該在一行中,並且方法和參數另寫一行,這樣可以使方法和參數更易讀。publicCounterSet(int size){this.size = size;}克隆方法如果這個類是可以被克隆的,那麼下一步就是 clone 方法:publicObject clone() {try {CounterSet obj = (CounterSet)super.clone();obj.packets = (int[])packets.clone();obj.size = size;return obj;}catch(CloneNotSupportedException e) {throw new InternalError(Unexpected CloneNotSUpportedException: +e.getMessage());}}類方法下面開始寫類的方法:/*** Set the packet counters* (such as when restoring from a database)*/protected finalvoid setArray(int[] r1, int[] r2, int[] r3, int[] r4)throws IllegalArgumentException{//// Ensure the arrays are of equal size//if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)throw new IllegalArgumentException(Arrays must be of the same size);System.array(r1, 0, r3, 0, r1.length);System.array(r2, 0, r4, 0, r1.length);}toString 方法無論如何,每一個類都應該定義 toString 方法:publicString toString() {String retval = CounterSet: ;for (int i = 0; i < data.length(); i++) {retval += data.bytes.toString();retval += data.packets.toString();}return retval;}}main 方法如果main(String[]) 方法已經定義了, 那麼它應該寫在類的底部.5、代碼可讀性避免使用不易理解的數字,用有意義的標識來替代。不要使用難懂的技巧性很高的語句。源程序中關系較為緊密的代碼應盡可能相鄰。6、代碼性能在寫代碼的時候,從頭至尾都應該考慮性能問題。這不是說時間都應該浪費在優化代碼上,而是我們時刻應該提醒自己要注意代碼的效率。比如:如果沒有時間來實現一個高效的演算法,那麼我們應該在文檔中記錄下來,以便在以後有空的時候再來實現她。不是所有的人都同意在寫代碼的時候應該優化性能這個觀點的,他們認為性能優化的問題應該在項目的後期再去考慮,也就是在程序的輪廓已經實現了以後。不必要的對象構造不要在循環中構造和釋放對象使用 StringBuffer 對象在處理 String 的時候要盡量使用 StringBuffer 類,StringBuffer 類是構成 String 類的基礎。String 類將 StringBuffer 類封裝了起來,(以花費更多時間為代價)為開發人員提供了一個安全的介面。當我們在構造字元串的時候,我們應該用 StringBuffer 來實現大部分的工作,當工作完成後將 StringBuffer 對象再轉換為需要的 String 對象。比如:如果有一個字元串必須不斷地在其後添加許多字元來完成構造,那麼我們應該使用StringBuffer 對象和她的 append() 方法。如果我們用 String 對象代替StringBuffer 對象的話,會花費許多不必要的創建和釋放對象的 CPU 時間。大家可以來安安DIY創作室一起討論。避免太多的使用 synchronized 關鍵字避免不必要的使用關鍵字 synchronized,應該在必要的時候再使用她,這是一個避免死鎖的好方法。7、編程技巧byte 數組轉換到 characters為了將 byte 數組轉換到 characters,你可以這么做:Hello world!.getBytes();Utility 類Utility 類(僅僅提供方法的類)應該被申明為抽象的來防止被繼承或被初始化。初始化下面的代碼是一種很好的初始化數組的方法:objectArguments = new Object[] { arguments };枚舉類型JAVA 對枚舉的支持不好,但是下面的代碼是一種很有用的模板:class Colour {public static final Colour BLACK = new Colour(0, 0, 0);public static final Colour RED = new Colour(0xFF, 0, 0);public static final Colour GREEN = new Colour(0, 0xFF, 0);public static final Colour BLUE = new Colour(0, 0, 0xFF);public static final Colour WHITE = new Colour(0xFF, 0xFF, 0xFF);}這種技術實現了RED, GREEN, BLUE 等可以象其他語言的枚舉類型一樣使用的常量。他們可以用 '==' 操作符來比較。但是這樣使用有一個缺陷:如果一個用戶用這樣的方法來創建顏色 BLACK new Colour(0,0,0)那麼這就是另外一個對象,'=='操作符就會產生錯誤。她的 equal() 方法仍然有效。由於這個原因,這個技術的缺陷最好註明在文檔中,或者只在自己的包中使用。8、編寫格式代碼樣式代碼應該用 unix 的格式,而不是 windows 的(比如:回車變成回車+換行)文檔化必須用 javadoc 來為類生成文檔。不僅因為它是標准,這也是被各種 java 編譯器都認可的方法。使用 @author 標記是不被推薦的,因為代碼不應該是被個人擁有的。縮進縮進應該是每行2個空格. 不要在源文件中保存Tab字元. 在使用不同的源代碼管理工具時Tab字元將因為用戶設置的不同而擴展為不同的寬度.如果你使用 UltrEdit 作為你的 Java 源代碼編輯器的話,你可以通過如下操作來禁止保存Tab字元, 方法是通過 UltrEdit中先設定 Tab 使用的長度室2個空格,然後用 Format|Tabs to Spaces 菜單將 Tab 轉換為空格。頁寬頁寬應該設置為80字元. 源代碼一般不會超過這個寬度, 並導致無法完整顯示, 但這一設置也可以靈活調整. 在任何情況下, 超長的語句應該在一個逗號或者一個操作符後折行. 一條語句折行後, 應該比原來的語句再縮進2個字元.{} 對{} 中的語句應該單獨作為一行. 例如, 下面的第1行是錯誤的, 第2行是正確的:if (i>0) { i ++ }; // 錯誤, { 和 } 在同一行if (i>0) {i ++}; // 正確, { 單獨作為一行} 語句永遠單獨作為一行.如果 } 語句應該縮進到與其相對應的 { 那一行相對齊的位置。括弧左括弧和後一個字元之間不應該出現空格, 同樣, 右括弧和前一個字元之間也不應該出現空格. 下面的例子說明括弧和空格的錯誤及正確使用:CallProc( AParameter ); // 錯誤CallProc(AParameter); // 正確不要在語句中使用無意義的括弧. 括弧只應該為達到某種目的而出現在源代碼中。下面的例子說明錯誤和正確的用法:if ((I) = 42) { // 錯誤 - 括弧毫無意義if (I == 42) or (J == 42) then // 正確 - 的確需要括弧9、代碼編譯1.編寫代碼時要注意隨時保存,並定期備份,防止由於斷電、硬碟損壞等原因造成代碼丟失。2.同一項目組內,最好使用相同的編輯器,並使用相同的設置選項。3.合理地設計軟體系統目錄,方便開發人員使用。4.打開編譯器的所有告警開關對程序進行編譯。5.在同一項目組或產品組中,要統一編譯開關選項。6.使用工具軟體(如Visual SourceSafe)對代碼版本進行維護。如果大家有不明白的可以到安安DIY創作室留言。10、可移植性Borland Jbulider 不喜歡 synchronized 這個關鍵字,如果你的斷點設在這些關鍵字的作用域內的話,調試的時候你會發現的斷點會到處亂跳,讓你不知所措。除非必須,盡量不要使用。換行如果需要換行的話,盡量用 println 來代替在字元串中使用\n。你不要這樣:System.out.print(Hello,world!\n);要這樣:System.out.println(Hello,world!);或者你構造一個帶換行符的字元串,至少要象這樣:String newline = System.getProperty(line.separator);System.out.println(Hello world + newline);PrintStreamPrintStream 已經被不贊成(deprecated)使用,用 PrintWrite 來代替它。
❸ 課程設計的程序 用戶使用說明書模板
你是做C語言大作業設計么?還是其他?
❹ 軟體詳細設計說明書
面向對象軟體設計說明書模板
1 概述
1.1 系統簡述
對系統要完成什麼,所面向的用戶以及系統運行的環境的簡短描述,這部分主要來源於需求說明書的開始部分。
1.2 軟體設計目標
這部分論述整個系統的設計目標,明確地說明哪些功能是系統決定實現而哪些時不準備實現的。同時,對於非功能性的需求例如性能、可用性等,亦需提及。需求規格說明書對於這部分的內容來說是很重要的參考,看看其中明確了的功能性以及非功能性的需求。
這部分必須說清楚設計的全貌如何,務必使讀者看後知道將實現的系統有什麼特點和功能。在隨後的文檔部分,將解釋設計是怎麼來實現這些的。
1.3 參考資料
列出本文檔中所引用的參考資料。(至少要引用需求規格說明書)
1.4 修訂版本記錄
列出本文檔修改的歷史紀錄。必須指明修改的內容、日期以及修改人。
2 術語表
對本文檔中所使用的各種術語進行說明。如果一些術語在需求規格說明書中已經說明過了,此處不用再重復,可以指引讀者參考需求說明。
3 用例
此處要求系統用用例圖表述(UML),對每個用例(正常處理的情況)要有中文敘述。
4 設計概述
4.1 簡述
這部分要求突出整個設計所採用的方法(是面向對象設計還是結構化設計)、系統的體系結構(例如客戶/伺服器結構)以及使用到的相應技術和工具(例如OMT、Rose)
4.2 系統結構設計
這部分要求提供高層系統結構的描述,使用方框圖來顯示主要的組件及組件間的交互。最好是把邏輯結構同物理結構分離,對前者進行描述。別忘了說明圖中用到的俗語和符號。
4.2.1 頂層系統結構
4.2.2 子系統1結構
4.2.3 子系統2結構
4.3 系統界面
各種提供給用戶的界面以及外部系統在此處要予以說明。如果在需求規格說明書中已經對用戶界面有了敘述,此處不用再重復,可以指引讀者參考需求說明。如果系統提供了對其它系統的介面,比如說從其它軟體系統導入/導出數據,必須在此說明。
4.4 約束和假定
描述系統設計中最主要的約束,這些是由客戶強制要求並在需求說明書寫明的。說明系統是如何來適應這些約束的。
另外如果本系統跟其它外部系統交互或者依賴其它外部系統提供一些功能輔助,那麼系統可能還受到其它的約束。這種情況下,要求清楚地描述與本系統有交互的軟體類型(比如某某某資料庫軟體,某某某EMail軟體)以及這樣導致的約束(比如只允許純文本的Email)。
實現的語言和平台也會對系統有約束,同樣在此予以說明。
對於因選擇具體的設計實現而導致對系統的約束,簡要地描述你的想法思路,經過怎麼樣的權衡,為什麼要採取這樣的設計等等。
5 對象模型
5.1 系統對象模型
提供整個系統的對象模型,如果模型過大,按照可行的標准把它劃分成小塊,例如可以把客戶端和伺服器端的對象模型分開成兩個圖表述。
對象圖應該包含什麼呢?
在其中應該包含所有的系統對象。這些對象都是從理解需求後得到的。要明確哪些應該、哪些不應該被放進圖中。
所有對象之間的關聯必須被確定並且必須指明聯系的基數(一對一、一對多還是多對多,0..1,*,1..*)。聚合和繼承關系必須清楚地確定下來。每個圖必須附有簡單的說明。
可能經過多次反復之後才能得到系統的正確的對象模型。
6 對象描述
在這個部分敘述每個對象的細節,它的屬性、它的方法。在這之前必須從邏輯上對對象進行組織。你可能需要用結構圖把對象按子系統劃分好。
為每個對象做一個條目。在系統對象模型中簡要的描述它的用途、約束(如只能有一個實例),列出它的屬性和方法。如果對象是存儲在持久的數據容器中,標明它是持久對象,否則說明它是個臨時對象(transient object)。
對每個對象的每個屬性詳細說明:名字、類型,如果屬性不是很直觀或者有約束(例如,每個對象的該屬性必須有一個唯一的值或者值域是有限正整數等)。
對每個對象的每個方法詳細說明:方法名,返回類型,返回值,參數,用途以及使用的演算法的簡要說明(如果不是特別簡單的話)。如果對變數或者返回值由什麼假定的話,Pre-conditions和Post-conditions必須在此說明。列出它或者被它調用的方法需要訪問或者修改的屬性。最後,提供可以驗證實現方法的測試案例。
6.1 子系統1中的對象
6.1.1 對象:對象1
用途:
約束:
持久性:
6.1.1.1 屬性描述:
1. 屬性:屬性1
類型:
描述:
約束:
2. 屬性:屬性2
6.1.1.2 方法描述:
1. 方法:方法1
返回類型:
參數:
返回值:
Pre-Condition:
Post-Condition:
讀取/修改的屬性:
調用的方法:
處理邏輯:
測試例:用什麼參數調用該方法,期望的輸出是什麼……
7 動態模型
這部分的作用是描述系統如何響應各種事件。例如,可以建立系統的行為模型。一般使用順序圖和狀態圖。
確定不同的場景(Scenario)是第一步,不需要確定所有可能的場景,但是必須至少要覆蓋典型的系統用例。不要自己去想當然地創造場景,通常的策略是描述那些客戶可以感受得到的場景。
7.1 場景(Scenarios)
對每個場景做一則條目,包括以下內容:
場景名:給它一個可以望文生義的名字
場景描述:簡要敘述場景是干什麼的以及發生的動作的順序。
順序圖:描述各種事件及事件發生的相對時間順序。
7.1.1 場景:場景1
描述:
動作1
動作2
7.2 狀態圖
這部分的內容包括系統動態模型重要的部分的狀態圖。可能你想為每個對象畫一個狀態圖,但事實上會導致太多不期望的細節信息,只需要確定系統中一些重要的對象並為之提供狀態圖即可。
7.2.1 狀態圖1:
8 非功能性需求
在這個部分,必須說明如何處理需求文檔中指定的非功能性需求。盡可能客觀地評估系統應付每一個非功能性的需求的能力程度。如果某些非功能性需求沒有完全在設計的系統中實現,請務必在此說明。另外,你也需要對系統將來的進化作一個估計並描述本設計如何使系統能夠適應這些可預見的變化。
9 輔助文檔
提供能幫助理解設計的相應文檔。
10 詞彙索引
文章錄入
❺ 軟體使用說明書如何寫(包含哪些內容)有沒有模板的
有的,網上可以搜到挺多,我不知道怎麼提供給你下載,這個你可以參考參考。
軟體使用說明書模板
1. 引言
1.1編寫目的【闡明編寫手冊的目的。指明讀者對象。】
1.2項目背景【說明項目來源、委託單位、開發單位及主管部門】
1.3 定義【列出手冊中使用的專門術語的定義和縮寫詞的原意】
1.4參考資料【列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源,
可包括:a.項目的計劃任務書、合同或批文;b.項目開發計劃;C. 需求規格說
明書;d.概要設計說明書;e。詳細設計說明書;f.測試計劃;g。手冊中引用
的其他資料、採用的軟體工程標准或軟體工程規范。】
2. 軟體概述
2.1目標
2.2功能
2.3 性能
a.數據精確度【包括輸入、輸出及處理數據的精度】
b.時間特性【如響應時間、處理時間、數據傳輸時間等。】
c.靈活性【在操作方式、運行環境需做某些變更時軟體的適應能力。】
3. 運行環境
3.1硬體【列出軟體系統運行時所需的硬體最小配置,如a. 計算機型號、主存容量;b.
外存儲器、媒體、記錄格式、設備型號及數量;c。輸入、輸出設備;d.數據傳輸設
備及數據轉換設備的型號及數量。】
3.2支持軟體【如:a。操作系統名稱及版本號;b. 語言編譯系統或匯編系統的名稱及版
本號;C。資料庫管理系統的名稱及版本號;d.其他必要的支持軟體。】
4. 使用說明
4.1安裝和初始化【給出程序的存儲形式、操作命令、反饋信息及其含意、表明安裝完成
的測試實例以及安裝所需的軟體工具等。】
4.2輸入【給出輸入數據或參數的要求。】
4.2.1數據背景【說明數據來源、存儲媒體、出現頻度、限制和質量管理等。】
4.2.2數據格式【如:a。長度;b.格式基準;C,標號;d.順序;e。分隔符;f.
詞彙表;g. 省略和重復;h.控制。】
4.2.3輸入舉例
4.3輸出【給出每項輸出數據的說明】
4.3.l數據背景【說明輸出數據的去向使用頻度、存放媒體及質量管理等。】
4.3.2數據格式【詳細闡明每一輸出數據的格式,如:首部、主體和尾部的具體形式。】
4.3.3舉例
4.4出錯和恢復【給出:a。出錯信息及其含意;b.用戶應採取的措施,如修改、恢復、
再啟動.】
4.5求助查詢【說明如何操作】
5. 運行說明
5.1運行表【列出每種可能的運行情況,說明其運行目的。】
5.2運行步驟【按順序說明每種運行的步驟,應包括:】
5.2.1運行控制
5.2.2操作信息
a. 運行目的;b.操作要求;C。啟動方法; d.預計運行時間;e。操作命令格
式及格式說明;f.其他事項。
5.2.3輸入/輸出文件【給出建立或更新文件的有關信息,如:】
a.文件的名稱及編號;b.記錄媒體;C。存留的目錄;d.文件的支配
【說明確定保留文件或廢棄文件的准則,分發文件的對象,佔用硬體的優先
級及保密控制等.】
5.2.4啟動或恢復過程
6. 非常規過程
【提供應急或非常規操作的必要信息及操作步驟,如出錯處理操作、向後備系統切換操作以
及維護人員須知的操作和注意事項。】
7. 操作命令一覽表
【按字母順序逐個列出全部操作命令的格式、功能及參數說明。】
8. 程序文件(或命令文件)和數據文件一覽表
【按文件名字母順序或按功能與模塊分類順序逐個列出文件名稱、標識符及說明。】
9. 用戶操作舉例
❻ 軟體設計說明書應該怎麼寫
軟體設計說明書編寫規范
一、 編寫目的
二、 應用文檔
三、 要求及內容
2.1 編寫格式要求
2.2 說明書內容
2.2.1 說明書目的
2.2.2 參考資料及文檔
2.2.3 設計原則
2.2.4 介面描述
2.2.5 功能描述
2.2.6 介面協議
2.2.7 編程協定
2.2.8 數據結構
2.2.9 邏輯結構
2.2.10 程序流程
2.2.11 源文件列表
2.2.12 其他
2.3 文檔修訂歷史
四、 編寫文檔注意事項
五、 樣例及模板文檔
❼ 軟體使用手冊怎麼寫
在網上復制給你的
引言
1.1編寫目的
【闡明編寫手冊的目的。指明讀者對象。】
1.2項目背景
【說明項目來源、委託單位、開發單位及主管部門】
1.3 定義
【列出手冊中使用的專門術語的定義和縮寫詞的原意】
1.4參考資料
【列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源,可包括:a.項目的計劃任務書、合同或批文;b.項目開發計劃;C. 需求規格說明書;d.概要設計說明書;e。詳細設計說明書;f.測試計劃;g。手冊中引用的其他資料、採用的軟體工程標准或軟體工程規范。】
2. 軟體概述
2.1目標
2.2功能
2.3 性能
a.數據精確度【包括輸入、輸出及處理數據的精度】
b.時間特性【如響應時間、處理時間、數據傳輸時間等。】
c.靈活性【在操作方式、運行環境需做某些變更時軟體的適應能力。】
3. 運行環境
3.1硬體
【列出軟體系統運行時所需的硬體最小配置,如
a. 計算機型號、主存容量;
b. 外存儲器、媒體、記錄格式、設備型號及數量;
c. 輸入、輸出設備;
d. 數據傳輸設備及數據轉換設備的型號及數量。】
3.2支持軟體
【如:a. 操作系統名稱及版本號;
b. 語言編譯系統或匯編系統的名稱及版本號;
c. 資料庫管理系統的名稱及版本號;
d. 其他必要的支持軟體。】
4. 使用說明
4.1安裝和初始化
【給出程序的存儲形式、操作命令、反饋信息及其含意、表明安裝完成的測試實例以及安裝所需的軟體工具等。】
4.2輸入
【給出輸入數據或參數的要求。】
4.2.1數據背景
【說明數據來源、存儲媒體、出現頻度、限制和質量管理等。】
4.2.2數據格式
【如:a。長度;b.格式基準;C,標號;d.順序;e。分隔符;f.詞彙表;g. 省略和重復;h.控制。】
4.2.3輸入舉例
4.3輸出
【給出每項輸出數據的說明】
4.3.l數據背景
【說明輸出數據的去向使用頻度、存放媒體及質量管理等。】
4.3.2數據格式
【詳細闡明每一輸出數據的格式,如:首部、主體和尾部的具體形式。】
4.3.3舉例