java開發文檔怎麼寫
❶ java 項目需求文檔要怎麼寫
5.在線預覽、分享更便捷
在摹客中在線撰寫或上傳的產品需求文檔，可通過鏈接快速分享給團隊成員，團隊成員獲得鏈接後可自由查看，當產品需求文檔有修改時，團隊成員仍可通過鏈接查看最新版本。
使用摹客等高效便捷的產品文檔撰寫工具，可以簡化產品文檔撰寫流程，提升產品經理的文檔撰寫能力，讓產品經理事半功倍。
總結
產品需求文檔作為產品開發團隊的重要溝通文檔，文檔的質量好壞會直接影響到各部門是否能夠明確產品的功能和邏輯。一份簡潔易懂、邏輯清晰的產品需求文檔，可以讓團隊溝通更加高效，從而有效提高產品開發團隊的工作效率。
❷ Java開發工作內容怎麼寫
在求職的時候，面試企業會要求我們描述之前的工作內容，那伍桐么Java開發的工作內容如何寫呢？下面是我整理的相關內容，希望對大家有所幫助！
Java開發的工作內容
1、負責研發公司應用軟體的模塊設計、開發和交付
2、負責編碼，單元測試
3、按照功能組件的詳細設計
4、對其他軟體工程師的代碼進行審核
5、參與新知識的學習和培訓
6、修復程序BUG
7、參與與其業務相關的需求變更評審
8、完成上級交辦的其他事宜
9、編寫技術設計文檔
Java開發就業方向
1、軟體設計師
其實很多Java程序員走到這個階段已經在做軟體設計師工作了，這是絕大多數程序員發展的必經之路。
程序員在編程序的時候，一方面會實現設計的功能，另一方面也在對設計有一個理解、認識、熟知的過程，進而慢慢地從學習別人設計，轉向到自己參與或獨立設計。
2、 項目經理
也有一些Java程序員工作機遇比較好，不但負責了項目的設計工作，而且負責了項目管理工作，對項目經理這個工作有了一定的嘗試。因此，這類程序員可以審視一下自己，是否合適這項耐橘茄工作，如果自己對這種工作比較滿意，而且具備項目經理的要求，則可以向項目經理這個方向發展。
3、 軟體營銷
Java程序員在工作中不免會接觸到用戶，不免會了解到用戶的需求。從而了解到軟體實際發揮的作用，進而了解了自身的工作價值所在。有的程序員則固步自封，不願意和外界打交道，從內心裡堅守技術底線。而有的程序員則喜歡和外人交流，喜歡把自己的軟體推薦給用戶，而且用戶也樂意昌察接受這種專業的介紹，用戶的接受是程序員價值的直接實現，程序員因此獲得了工作成就感。
❸ java api介面文檔怎麼編寫
Java語言提供了一種強大的注釋形式：文檔注釋。可以將源代碼里的文檔注釋提取成一份系統的API文檔。我們在開發中定兆拍義類族慶羨、方法時可以先添加文檔注釋，然後使用javadoc工具來生成自己的API文檔。
文檔注釋以斜線後緊跟兩個星號（/**）開始，以星號後緊跟一個斜線（*/）作為結尾，中間部分全部都是文檔注釋，會被提取到API文檔中。
自行搜索一下javadoc即可，示例如下：
/** * 類描述 * * @author 作者 * @version 版本 */public class DemoClass { /** * 內部屬性：name */ private String name; /** * Setter方法 * @return name */ public String getName() { return name; } /** * Getter方法 * @param name */ public void setName(String name) { 差塵this.name = name; } }
❹ java介面文檔怎麼寫
一些剛開始寫介面文檔的服務端同學，很容易按著代碼的思路去編寫介面文檔，這讓客戶端同學或者是服務對接方技術人員經常吐槽，看不懂介面文檔。這篇文章提供一個常規介面文檔的編寫方法，給大家參考。
推薦使用的是docway寫介面文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。
一、請求參數
1. 請求方法
GET
POST
PUT
DELETE
其他
application/x-www-form-urlencoded
application/json
application/xml
multipart/form-data
用於獲取數據
用於更新數據，可與PUT互換，語義上PUT支持冪等
用於新增數據，可與POST互換，語義上PUT支持冪等
用於刪除數據
其他的請求方法在一般的介面中很少使用。如：PATCH HEAD OPTIONS
2. URL
url表示了介面的請求路徑。路徑中可以包含參數，稱為地址參數，如**/user/{id}**，其中id作為一個參數。
3. HTTP Header
HTTP Header用於此次請求的基礎信息，在介面文檔中以K-V方式展示，其中Content-Type則是一個非常必要的header，它描述的請求體的數據類型。
常用的content-type：
請求參數使用「&」符號連接。
內容為json格式
內容為xml格式
內容為多個數據組成，有分隔符隔開
4. HTTP Body
描述http body，依賴於body中具體的數據類型。如果body中的數據是對象類型。則需要描述對象中欄位的名稱、類型、長度、不能為空、默認值、說明。以表格的方式來表達最好。
示例：
五、介面工具
推薦使用的是http://docway.net（以前叫小幺雞） 寫介面文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。
❺ 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 來代替它。
❻ java開發文檔怎麼寫
問了一下我在遠標教育的哥們，他說要做java開發文檔得做不少功夫，有需求規格說明書、詳細設計說明書、軟體功能規格說明書、資料庫設計說明書、編碼規范等。比較重要的是 軟體功能描述、資料庫設計、編碼規范，這樣，及時有人員流動的話，新人看了文檔，也能比較快的了解功能需求、資料庫設計、編碼規范，更快的上手項目。
❼ 請教JAVA程序如何寫
為了在您的機器上配置起一個Java開發環境——您將使用一個「開發環境」來「開發」（編寫）程序——您需要完成以下這些步驟：
1.下載一個包含Java開發環境（編譯器和其他工具）的大文件。點擊「下載J2SE SDK」鏈接下載SDK（軟體開發工具包）軟體。網頁會顯示一個許可協議。點擊「接受」。選擇您的操作系統，然後將文件保存到下載目錄中。這是一個巨大的文件，用電話數據機下載需要好幾個小時。接下來的兩個文件也很大。
2.下載一個包含Java文檔的大文件。選擇操作系統後點擊SDK1.4.1文檔的鏈接。
3.如果您的機器上還沒有安裝WinZip（或可執行相同功能的程序），那麼您需要下載一個包含WinZip的大文件並安裝之。如果您的機器上沒有安裝某個的版本的WinZip或其他解壓縮軟體，下載WinZip的試用版。運行EXE文件安裝。很快我們將使用它來安裝文檔。
4.安裝Java開發環境。運行第一步下載的j2sdk-1_4_1-*.exe文件。他將自動解壓並安裝開發工具包。
5.安裝文檔。閱讀安裝說明文檔。它會要求您將文檔文件移至剛才開發工具包的安裝目錄。將文檔解壓縮，文件就會被安排到適當的位置。
6.調整環境變數。按照此頁的要求，您需要改變路徑變數。最簡單的辦法是打開一個MS-DOS窗口鍵入PATH看看當前的路徑變數是什麼，然後用記事本打開autoexec.bat按要求修改PATH環境變數。
7.全面測試。現在您應該可以打開另一個MS-DOS窗口並鍵入javac了。如果一切設置妥當，那麼您將看到屏幕將輸出兩行文字告訴您如何使用javac。這意味著一切已經准備就緒了。如果您看到「錯誤的命令或文件名」這條消息，則說明還沒有準備好。請重新閱讀安裝說明檢查哪裡出了問題。確定PATH被正確設置並可用。回頭重新閱讀上面的步驟，問題不解決不要輕易放棄。現在您已自豪地擁有一台能夠編譯Java程序的機器了。您已經准備好開始編寫軟體了！
02
順便指出，剛才您解壓縮的內容包括一個demo（演示）目錄，其中包含許多精緻的例子。所有的例子都可以立即執行，所以您不妨找到這個目錄試運行一下其中的某些例子。許多例子都會發聲，所以請打開揚聲器。要運行例子，找到名如example1.html的網頁文件並使用您常用的瀏覽器打開即可。
03
您的第一個程序將是小巧可愛的。它將建立一個繪圖區域並在其上繪制一條對角線。創建此程序您需要：
1.打開記事本鍵入（或復制粘貼）程序 。建立一個新目錄以保存程序。打開記事本（或其他可以創建TXT文件的文本編輯器）。將范常式序錄入或復制粘貼到記事本窗口中。切記：輸入程序的大小寫敏感。因此必須按照范常式序中字母的大小寫輸入。重審以上編程步驟。如果錄入內容和范常式序不是完全一致，則程序將無法正常運行。
2.保存程序 。將文件在第一步創建的路徑下保存，文件名為FirstApplet.java。文件名大小寫敏感。請確保字母「F」和「A」大寫，其他字母小寫，如前所示。
3.使用Java編譯器編譯程序生成一個Java程序 。
打開一個MS-DOS窗口。改變至包含FirstApplet.java的路徑下（cd），鍵入：
javac FirstApplet.java
記住大小寫敏感！或者編譯成功，這時屏幕不輸出任何信息，或者有錯誤發生。若沒有錯誤，則會在目錄里生成一個名為FirstApplet.class的文件與FirstApplet.java並列。
（請確保程序保存的文件名為FirstApplet.java而不是FirstApplet.java.txt。最簡單的辦法就是在MS-DOS窗口下鍵入dir然後查看文件名。若擴展名是.txt 則請重命名文件去掉此擴展名。也可以運行Windows資源管理器在「查看」菜單下點擊「選項」。確保「隱藏已注冊的MS-DOS文件擴展名」選項處於未選中狀態，然後在資源管理器中查看文件名。若需要則將文件改名。）
4.排除問題。若有問題產生則想辦法解決。將您的程序與上面的范常式序對比，使之完全相同。修改過程中不斷編譯程序，直到沒有錯誤發生。
5.建立一個HTML網頁「包含」剛創建的Java程序 。
創建一個HTML頁面來包含小程序。另開一個記事本窗口。錄入下面的內容：
將此文件存於同一目錄中，文件名為applet.htm。
04
1.運行Java程序 。
在您的MS-DOS窗口中鍵入：
appletviewer applet.htm
應該可以看見一條從左上角到右下角的對角線：（如上圖所示）
將小程序查看器的窗口拉大一些以查看整條對角線。您也可以將此HTML網頁裝載到任何現用的瀏覽器中，如Netscape Navigator或微軟IE，看到的結果是大致相同的。
使用Java語言編程就需要一個Java編譯器。下一節將指導您下載並安裝一個編譯器。一旦有了編譯器我們就可以開始學習編程了。下載和安裝過程將會持續幾個小時，大部分時間用來下載幾個很大的文件。您還需要有大約40兆位元組的空閑磁碟空間（開始前請確定有足夠的空間）
❽ 如何書寫Java項目的開發文檔
我現在公司是CMMI4認證的，最近我項目組在開始新產品，我負責了大部分文檔編寫。。
人員流動是項目進行中比較讓人頭疼的事情。做好規範文檔，可以讓代碼看起來比較像出自同一人之手。要做java開發文檔得做不少功夫，有需求規格說明書、詳細設計說明書、軟體功能規格說明書、資料庫設計說明書、編碼規范等。比較重要的是 軟體功能描述、資料庫設計、編碼規范，這樣，及時有人員流動的話，新人看了文檔，也能比較快的了解功能需求、資料庫設計、編碼規范，更快的上手項目。先看看你需要什麼文檔，然後去文庫里搜索，就有相應的模板，找個適合自己項目的模板用。