小白如何寫需求文檔


上學期在跟着網站里的學長學姐學了許多東西,假期我們需要自己做一套網站簽到OA出來,昨天剛剛把需求文檔定下,萬事開頭難,我把邁出的第一步記錄下來,也給第一次寫文檔的小伙伴一些建議。

第 一次寫,難免無從下手,在網上查找了大量的需求文檔范例,網上也有模板,不過模板上東西很多,有些我還並不太了解,也不太適用於自己我們要做的OA. 既然是需求文檔,那就應該根據項目實際情況去寫文檔,所以我們在寫文檔時注重的是我們需不需要,而非和模板是否符合。接下來,是我們寫文檔的步驟。

1、定框架

首先要把整篇文檔需要的內容,大標題,子標題記錄下來,即做成目錄的形式。如圖,這是我跟模板內容選出來的符合我的需要的,加以整理。

2.書寫文字部分

在定好框架之后,我開始寫引言、和環境需求、非功能需求的部分,這些相對好寫,耗費時間也不長,可網上搜索資料,可和搭檔討論,這里也很重要,要考慮多方面的問題。

3.定功能、寫功能需求

開 始寫功能需求之前,首先要大家要把目標功能定下來,每個功能的細節也要討論到,討論過程中要做記錄手稿,全靠腦袋是記不住的。這一步很重要,千萬不可以想 到一個功能添加一個,因為各功能之間會有關聯,臨時起意的功能很容易導致各功能之間存在矛盾或重復,最后寫出來也會讓人看不懂。其次注意功能要切合實際, 不能想怎樣就怎樣,要考慮到后期實現的可能性,以及用戶體驗感,這個功能是否必要或多余。

功能定好之后,就可以愉快的總結出來,制成表格 啦。每個功能要說明名稱、編號、操作流程(即如何使用此功能)、和備注。若功能分類較多,要注意命名時的簡潔易懂,分類清晰,會給后面代碼的編寫帶來很大 的方便。操作流程也是盡可能詳細,記錄下對每個功能如何實現的詳細想法,同樣是為編寫代碼省去麻煩。

4.數據庫建表、畫ER圖

這步需要時間較長。我們是先畫出ER圖,再根據圖建表,會快很多。

畫圖之前要搞清楚需要哪些數據,又有哪些表,以及表與表之間的關系。畫圖時,以矩形作為表名,橢圓形為表的屬性值,菱形代表兩表之間的關系。

有圖之后,建表就可以根據ER圖來做,兩者要保持一致。

表的內容包括,列名、數值類型、長度、是否為空、主外鍵設置等

5.補充修改細節

在上面四步都做好之后,整篇文檔基本成型了。最后我們又多次瀏覽文檔,尤其是功能,檢查實現功能的邏輯是否合理。一定要大家一起討論,自己一個人是看不出問題的。如果有學長學姐,最好請教一下他們,他們會給出很棒很好的建議,並且指出錯誤,可以進一步完善文檔。

以上就是我們在寫需求文檔時的步驟。如果有不當錯誤之處,希望您能給小白指明,這樣小白才能改正錯誤、獲得進步。謝謝您的閱覽!

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM