java技術文檔怎麼寫 - 如何書寫Java項目的開發文檔
我現在公司是CMMI4認證的,最近我項目組在開始新產品,我負責了大部分文檔編寫。
人員流動是項目進行中比較讓人頭疼的事情。做好規範文檔,可以讓代碼看起來比較像出自同一人之手。要做java開發文檔得做不少功夫,有需求規格説明書、詳細設計説明書、軟件功能規格説明書、數據庫設計説明書、編碼規範等。比較重要的是 軟件功能描述、數據庫設計、編碼規範,這樣,及時有人員流動的話,新人看了文檔,也能比較快的瞭解功能需求、數據庫設計、編碼規範,更快的上手項目。先看看你需要什麼文檔,然後去文庫裏搜索,就有相應的模板,找個適合自己項目的模板用。
2.java 項目需求文檔要怎麼寫需求文檔一般分兩類
需求調研報告
需求分析報告
調研報告:是記錄的用户的原始需求,基本上可以算做是和用户溝通的原始記錄。
分析報告:是對調研報告進行歸類分析的結果。一個比較全面的文檔了,在這個文檔裏面一般包含以下內容:
項目的背景
項目的目標
項目的範圍
用户特點
相關技術、規範標準等
相關約束
用户的組織結構、角色等
用户需要的功能點,這些功能的優先級,業務流程、功能特點,有沒有特殊需求等等
總而言之,需求分析報告的下一站是給設計人員的,設計人員看到需求分析報告就知道系統應該包含哪些功能點、權限設計、流程設計等,這些內容都可以直接從需要分析報告裏面得出
3.自己寫Java文檔一般需要有哪些內容每個非 private 方法的參數説明,像 getter/setter 這樣簡單的就省略掉。主要是關鍵方法和類的設計要有説明。另外,一些方法有內部的實現約定,也就是前提條件,這個在技術上沒辦法驗證的或驗證它會影響性能等,我們就只在文檔中説明,不在代碼中檢查了。舉個例子,java.util.ArrayList 不是一個線程安全的集合實現類,它就在文檔中説明了這點,另一個就是 equals 和 hashcode 方法在你覆蓋它時應該同時按相同的算法覆蓋兩個,只覆蓋一個就不符合設計約定。再一個就是簡要説明你的關鍵方法和類是如何設計的。
一個好的文檔可以用來回答 What, Why & hoW 這三個 W。