java項目文檔怎么寫 _文檔

1.java 項目需求文檔要怎么寫需求文檔一般分兩類
需求調研報告
需求分析報告
調研報告：是記錄的用戶的原始需求，基本上可以算做是和用戶溝通的原始記錄。
分析報告：是對調研報告進行歸類分析的結果。一個比較全面的文檔了，在這個文檔里面一般包含以下內容：
項目的背景
【java項目文檔怎么寫】項目的目標
項目的范圍
用戶特點
相關技術、規范標準等
相關約束
用戶的組織結構、角色等
用戶需要的功能點，這些功能的優先級，業務流程、功能特點，有沒有特殊需求等等
總而言之，需求分析報告的下一站是給設計人員的，設計人員看到需求分析報告就知道系統應該包含哪些功能點、權限設計、流程設計等，這些內容都可以直接從需要分析報告里面得出
2.java項目做完怎么寫說明文檔如果你參與了項目，最好寫清楚參與的項目的時間，項目描述，自己在這個項目中的主要責任，以及在項目中用到的技術和自己在項目中學到的東西
完成了xxx部分編碼/測試/設計，（在xxx時間內）實現了yyyy功能，使得項目獲得了zzzz收益，獲得dddd獎勵。
可以在項目描述中談談自己在實現某項功能時用到了什么技術，如用MySQL的 limit語句實現分頁功能
先介紹一下項目要實現的功能，在介紹下程序的結構劃分（MVC），再談下MVC各是用什么技術實現的（如View用了JSP、JSTL,Controller使用Struts2的過濾器。。。），然后介紹下實現主要功能時具體用了哪些技術（建議你多談點對AJAX的理解）
3.如何書寫Java項目的開發文檔我現在公司是CMMI4認證的，最近我項目組在開始新產品，我負責了大部分文檔編寫。
人員流動是項目進行中比較讓人頭疼的事情。做好規范文檔，可以讓代碼看起來比較像出自同一人之手。要做java開發文檔得做不少功夫，有需求規格說明書、詳細設計說明書、軟件功能規格說明書、數據庫設計說明書、編碼規范等。比較重要的是軟件功能描述、數據庫設計、編碼規范，這樣，及時有人員流動的話，新人看了文檔，也能比較快的了解功能需求、數據庫設計、編碼規范，更快的上手項目。先看看你需要什么文檔，然后去文庫里搜索，就有相應的模板，找個適合自己項目的模板用。
4.如何書寫Java項目的開發文檔我現在公司是CMMI4認證的，最近我項目組在開始新產品，我負責了大部分文檔編寫。
人員流動是項目進行中比較讓人頭疼的事情。
做好規范文檔，可以讓代碼看起來比較像出自同一人之手。要做java開發文檔得做不少功夫，有需求規格說明書、詳細設計說明書、軟件功能規格說明書、數據庫設計說明書、編碼規范等。
比較重要的是軟件功能描述、數據庫設計、編碼規范，這樣，及時有人員流動的話，新人看了文檔，也能比較快的了解功能需求、數據庫設計、編碼規范，更快的上手項目。先看看你需要什么文檔，然后去文庫里搜索，就有相應的模板，找個適合自己項目的模板用。
5.自己寫Java文檔一般需要有哪些內容每個非 private 方法的參數說明，像 getter/setter 這樣簡單的就省略掉。主要是關鍵方法和類的設計要有說明。另外，一些方法有內部的實現約定，也就是前提條件，這個在技術上沒辦法驗證的或驗證它會影響性能等，我們就只在文檔中說明，不在代碼中檢查了。舉個例子， java.util.ArrayList 不是一個線程安全的集合實現類，它就在文檔中說明了這點，另一個就是 equals 和 hashcode 方法在你覆蓋它時應該同時按相同的算法覆蓋兩個，只覆蓋一個就不符合設計約定。再一個就是簡要說明你的關鍵方法和類是如何設計的。