如果你參與了項(xiàng)目，最好寫清楚參與的項(xiàng)目的時間，項(xiàng)目描述，自己在這個項(xiàng)目中的主要責(zé)任，以及在項(xiàng)目中用到的技術(shù)和自己在項(xiàng)目中學(xué)到的東西 完成了xxx部分編碼測試設(shè)計(jì)，在xxx時間內(nèi)實(shí)現(xiàn)了yyyy功能，使得項(xiàng)目獲得了zzzz；說明文檔使用手冊一般用doc至于樓上提到的 商圈排行榜 author xxx date Sep 4， 2008 102048 AM return 是用來給類或類中的方法寫功能注釋的，在 eclipse中，使用這個類或者類中的方法時，鼠標(biāo)移到上面就會出現(xiàn)；20141006 求java項(xiàng)目開發(fā)具體流程，需求分析等 27 20120706 java項(xiàng)目分析 如何寫 1 20200513 JAVA需求分析是什么 3 20180418 java web的項(xiàng)目需求怎么寫？ 3 20090625 java 記事本需求分析該怎麼寫呢？ 5 201；C文檔工具推薦 1 調(diào)研結(jié)果需求分析說明書格式參照開發(fā)文檔模板2 單位組織結(jié)構(gòu)圖功能模塊分解圖用VISIO繪制，或直接用WORD中的畫圖工具3 業(yè)務(wù)流程圖用VISIO中的FLOWCHART模板繪制4 系統(tǒng)邏輯模型使用ROSE。

自己百度“宿舍管理系統(tǒng)”設(shè)計(jì)方案詳細(xì)設(shè)計(jì)，設(shè)計(jì)文檔類似的關(guān)鍵字看看，這個和JAVA WEB沒啥具體關(guān)系，javaweb只是它的表現(xiàn)形式你參考網(wǎng)上的文檔，按照模版把項(xiàng)目基本內(nèi)容填一下，功能方面你要的功能也就無非是quot入住quot；接口文檔，代碼層次比如公共方法寫在哪個class里，哪些為一大類在一個包下，數(shù)據(jù)字典，就是介紹你這個項(xiàng)目的架構(gòu)讓后來的人怎么能容易參與開發(fā)，交接什么看這個就可以方便些，輔助作用的一個文檔一般都是項(xiàng)目經(jīng)理寫；對方法中某參數(shù)的說明@return 對方法的說明 對方法返回值的說明@exception 對方法的說明 對方法可能拋出的異常進(jìn)行說明3命名規(guī)范定義這個規(guī)范的目的是讓項(xiàng)目中所有的文檔都看起來像一個人寫的，增加可讀性，減少項(xiàng)目組中因?yàn)閾Q人而帶來；用注釋的方法寫文檔，別人難找，直接在項(xiàng)目里專門建一個Readme文件夾，然后里面放txt的說明文檔，這方法土，但好用，但是做大的項(xiàng)目顯然就行不通了，嘿嘿；一編寫源代碼 1 首先，在D盤下建立任意建立一個目錄建議是非中文的目錄，這里我建立的目錄是javacode然后進(jìn)入該目錄，在該目錄下建立一個文件名是HelloWorldjava的普通文件2 使用文本打開該文件然后輸入一；Java語言提供了一種強(qiáng)大的注釋形式文檔注釋可以將源代碼里的文檔注釋提取成一份系統(tǒng)的API文檔我們在開發(fā)中定義類方法時可以先添加文檔注釋，然后使用javadoc工具來生成自己的API文檔文檔注釋以斜線后緊跟兩個星號**。

先寫修訂的人 然后寫這個項(xiàng)目是為了做什么的 然后用到的技術(shù)棧 然后詳細(xì)介紹功能 如果是web項(xiàng)目就先介紹各個接口，需要的參數(shù) 然后如果時間允許，把幾個重要的表 建模截圖放進(jìn)去；推薦使用的是docway 寫接口文檔，方便保存和共享，支持導(dǎo)出PDF MARKDOWN，支持團(tuán)隊(duì)項(xiàng)目管理一請求參數(shù) 1 請求方法 GET 用于獲取數(shù)據(jù) POST 用于更新數(shù)據(jù)，可與PUT互換，語義上PUT支持冪等 PUT 用于新增數(shù)據(jù)，可與POST互換；2 設(shè)計(jì)和實(shí)現(xiàn)Java應(yīng)用程序的架構(gòu)Java開發(fā)人員需要根據(jù)需求分析和系統(tǒng)設(shè)計(jì)文檔來設(shè)計(jì)和實(shí)現(xiàn)Java應(yīng)用程序的架構(gòu)，包括系統(tǒng)的組織結(jié)構(gòu)模塊的劃分?jǐn)?shù)據(jù)流程的設(shè)計(jì)等3 編寫和執(zhí)行單元測試和集成測試Java開發(fā)人員需要編寫單元；要做java開發(fā)文檔得做不少功夫，有需求規(guī)格說明書詳細(xì)設(shè)計(jì)說明書軟件功能規(guī)格說明書數(shù)據(jù)庫設(shè)計(jì)說明書編碼規(guī)范等比較重要的是 軟件功能描述數(shù)據(jù)庫設(shè)計(jì)編碼規(guī)范，這樣，及時有人員流動的話，新人看了文檔，也能比。

APIApplication Programming Interface，應(yīng)用程序編程接口是一些預(yù)先定義的函數(shù)，目的是提供應(yīng)用程序與開發(fā)人員基于某軟件或硬件得以訪問一組例程的能力，而又無需訪問源碼，或理解內(nèi)部工作機(jī)制的細(xì)節(jié)API函數(shù)包含在Windows系統(tǒng)目錄；使用word就可以，其中說明項(xiàng)目名稱，單位時間寫明項(xiàng)目結(jié)構(gòu)，命名規(guī)范，發(fā)展進(jìn)度，能考慮到的全放進(jìn)來，告訴新人他現(xiàn)在要做的是什么，以后要做的是什么他會明白的。