軟體項目開發應寫的13類文檔——sun軟體學院轉載

在軟體項目開發過程中，應該按軟體開發要求撰寫十三類文檔，文檔編製要求具有針對性、精確性、清晰性、完整性、靈活性、可追溯性！

需求階段

1、可行性分析報告

說明該軟體開發項目的實現在技術上、經濟上和社會因素上的可行性，評述為了合理地達到開發目標可供選擇的各種可能實施方案，說明並論證所選定實施方案的理由。

2、項目開發計劃

為軟體項目實施方案制訂出具體計劃，應該包括各部分工作的負責人員、開發的進度、開發經費的預算、所需的硬體及軟體資源等。

3、軟體需求說明書（軟體規格說明書）

對所開發軟體的功能、效能、使用者介面及運行環境等作出詳細的說明。它是在使用者與開發人員雙方對軟體需求取得共同理解並達成協議的條件下編寫的，也是實施開發工作的基礎。該說明書應給出資料邏輯和資料擷取的各項要求，為產生和維護系統資料檔案做好準備。

設計階段

4、概要設計說明書

該說明書是概要實際階段的工作成果，它應說明功能分配、模組劃分、程式的總體結構、輸入輸出以及介面設計、運行設計、資料結構設計和出錯處理設計等，為詳細設計提供基礎。

5、詳細設計說明書

著重描述每一模組是怎樣實現的，包括實現演算法、邏輯流程等。

開發階段

6、開發進度月報

該月報系軟體人員按月向管理部門提交的項目進展情況報告，報告應包括進度計劃與實際執行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。

測試階段

7、測試計劃

為做好整合測試和驗收測試，需為如何組織測試製訂實施計劃。計劃應包括測試的內容、進度、條件、人員、測試案例的選取原則、測試結果允許的偏差範圍等。

8、測試分析報告

測試工作完成以後，應提交測試計劃執行情況的說明，對測試結果加以分析，並提出測試的結論意見。

收尾階段

9、使用者操作手冊

本手冊詳細描述軟體的功能、效能和使用者介面，使使用者對如何使用該軟體得到具體的瞭解,為操作人員提供該軟體各種運行情況的有關知識，特別是操作方法的具體細節。

10、項目開發總結報告

軟體項目開發完成以後，應與項目實施計劃對照，總結實際執行的情況，如進度、成果、資源利用、成本和投入的人力，此外，還需對開發工作做出評價，總結出經驗和教訓。

11、軟體維護手冊

主要包括軟體系統說明、程式模組說明、作業環境、支援軟體的說明、維護過程的說明，便於軟體的維護。

維護階段

12、軟體問題報告

指出軟體問題的登記情況，如日期、發現人、狀態、問題所屬模組等，為軟體修改提供準備文檔。

13、軟體修改報告

軟體產品投入運行以後，發現了需對其進行修正、更改等問題，應將存在的問題、修改的考慮以及修改的影響作出詳細的描述，提交審批。

原稿出自：www.china-cio.com,轉載請註明出處。

 

 

 

請不要縮在項目或產品的“龜殼”裡面——sun軟體學院轉載

也許是呆在“龜殼”裡的時間太久了，以致於當下是個什麼世道都快搞不清楚了。當開發人員一天到晚忙於開發而不知周圍環境變化的時候，就成了這種情況。也許在技術上已突飛猛進，但其它方面能力卻在隨之退化。 其時做產品過程中一直存在一個比較有意思的地方，就是要同時考慮市場和技術。不僅是同行業的 發展，競爭者的動作，有時還要考慮處於相關上下遊產業鏈條中的一些公司和渠道，以及使用你產品的客戶所處行業的相關情況。沒有人能告訴你做什麼是對的， 有時完全是跟著感覺甚至競爭者走。 當客戶找上門來與你溝通，要你做這做那時，有些相法是可以接受的，有些則屬於是異想天開，當 然還有其它讓你啼笑皆非甚至BT的需求，因為從他們的角度出來，只要能賺錢，“一切皆有可能”，一切皆應存在。這時你就要結合自己的專業背景和市場分析能 力給他們講你對這些功能或問題的看法，並瞭解客戶提出這個功能或想法的初衷，以及評估與之相關解決方案的可行性，論證自己的想法。也許在一輪甚至幾輪交流 之後，你會發現開發這些功能並不像你一開始所遇想的那麼複雜（或者簡單）。只是當初把它想的過於複雜或者簡單了。我以前就愛犯一種毛病，急於編碼，到眼下 看來，很多的時間精力都被浪費了，其實使用者也許就是要一個小功能，而我卻不管不顧的將架構模式用了一大堆，導致過度設計嚴重，甚至背負了"拿客戶練手“之 嫌疑。而整天縮在項目或產品中就可能出現這種只想編碼不想其他的傾向。而一但與使用者接觸後，才被使用者用涼水潑醒。 而有些整天縮著頭在"龜殼"中寫垃圾代碼的同事，也別以為穿著"馬甲"出來別人就不 知道你是誰了，醜媳婦早晚要見公婆。等到向客戶或用人公司展示你的”作品“和思路時，大板子依舊會拍在你的屁股上。 我希望項目和產品背後的開發人員走出來，超碼走到同行中來交流你的設計思想和心得，這樣一方面鍛煉自己的表達能力，一方面也能驗證自己法，增強自信心。當然有些時候會被一些同行尖刻的指出其中弊端，甚至還有人身攻擊。不過要麼在挨罵中滅亡，要麼在挨罵中爆發。 爆發分兩種，一種是直接反唇相擊，不管腦袋屁股的一股腦頂回去。一種是踏實下來找原因，如果是自己做的不對，認錯並求得諒解，並在後續開發中進行糾正，如果自己沒問題則善意的指出對方觀點中存在的問題，或共同尋求解決方案，與客戶與同行一起成長。 不想再產品和項目中潛水了，時間長了之後真的會喪失在 “太陽下以及陸地上生活的能力“。 在從事開發多年之後，開始嘗試觀察圈子之外的環境，去擴充自己的天地。 原稿出自：www.china-cio.com，轉載請註明出處。