如何編寫優質的需求文件

2021-06-26 13:22:21 字數 2930 閱讀 9034

編寫需求文件,在嵌入式開發領域是非常普遍的。需求文件被用來定義開發任務,協調大規模的研發計畫。對於最終的產品,需求文件扮演著開發者行為和消費者行為之間溝通紐帶的角色。當需求文件書寫正確的時候,便可以發揮巨大的作用。然而,如果你在嵌入式開發領域工作的時間足夠長,你就會很快發現,這個領域裡不合格的需求文件實在是太多了。當你嘗試對這些不合格的文件進行修復時,你又會很快發現,編寫正確的需求文件絕非易事。在這裡,我們提出一些建議,希望能將書寫正確需求文件這件事情變得清晰一些。

從較高的層次來看,書寫需求文件的目的就是要提供對所需行為的有效描述。該所需行為可用乙個黑盒系統描述,並需要注意以下細節:

• 工程師可以根據系統所說進行實現

• 測試人員,在不與開發人員溝通的前提下,可以利用滿足硬體要求的裝置驗證需求。

• 最終產生的成果滿足終端使用者的要求。

書寫優質的需求文件:

最基本的原則是:需求文件應當盡量簡潔,用最易懂的描述來約束系統的預期行為。如果你遵循這個原則,剩下的那些重要因素(可測試性、避免過度設計等等)都將變得順理成章。

列舉一下更詳細的規則,通常會更有幫助。下面是書寫優質需求文件需要遵循的步驟:

1. 定義系統的邊界。這也是黑盒系統所必要的。

2. 定義輸入和輸出。這也應當是你看待內部系統的唯一方式。

3. 用最易懂的方式描述系統的預期行為

4. 除了輸入和輸出之外,你的需求是不是還涉及了系統的其他部分?如果是,那麼你的需求就設計過度了。重構需求,讓它變得精簡。

5. 你的需求是不是過於模稜兩可?加入更多的限定規範。注意:有些模稜兩可的描述並不是壞事,假設描述所包含的所有情況均可被接受,且測試的時候不需要附加的資訊加以說明,那麼就沒關係。你不需要(也不應該)把系統的行為限制得過頭。

6. 你的需求是否可測試?(這裡指的是黑盒測試)如果不是,你最好返回到第4步。如果這種返工發生很多次,那就說明你的黑盒無法正確描述系統,或者你的測試工具不夠優秀。無論是哪種情況,不可測試的需求文件幾乎就是一文不值的。

7. 你的需求文件通俗易懂麼?如果你的需求文件非常難以讀懂,那就說明你寫得不好,只能給那些照著你的需求負責實施的人帶來無盡的痛苦。如果是這樣,回到第3步。

8. 你是不是真的做到了第4步?你確認麼?再檢查一下。

例子:下面的例子,讓我們描述乙個自製的嵌入式裝置的需求,這個裝置能從彎曲感測器上讀取彎曲的頻率,並根據不同的頻率值讓乙個led閃爍。

顯然,我們已經完成了步驟2和步驟3了!

• 輸入:從彎曲感測器讀取資料。

• 輸出:led。

但是我們跳過了步驟1:

• 在這個例子裡,我們將把黑盒畫到裝置的微處理器上。

讓我們繼續往下進行,

第四步:除了輸入和輸出以外,我們是否還涉及了其他的系統邊界?

• 微處理器並不關心從彎曲感測器讀取什麼樣的資料,從處理器的角度來看,僅需要做的是測量adc腳的電壓而已。

• led僅由數字輸出腳控制。

下面,讓我們來修正這個問題:

第0版本的需求:

1. 該裝置應當根據adc腳的不同頻率的電壓,來切換數字輸出端的狀態。

第五步: 需求寫模稜兩可麼?

恩,我們的描述太模稜兩可了.輸出端切換的速度要多快? 跟電壓的關係如何? 輸入電壓的範圍是多少? 讓我們加一些更細節的描述吧:

版本0.1

1. 輸出端應當由乙個自由活動的定時器進行控制

2. 自由執行定時器的頻率最高不得高於每秒10次,不得低於每秒1次.

3. 自由執行定時器的觸發頻率應當在最高和最低值之間呈線性變化,並與adc端的輸入電壓成正比.

4. adc端的輸入電壓應當每100毫秒讀取一次

5. 當adc端的輸入電壓端被讀入時,控制自由執行定時器週期時間的註冊值也應當被更新.

6. adc輸入端的電壓有效範圍應當被控制在0到1伏之間.

第六步: 你的需求是可測試的麼?

• 首先,自由執行的定時器在這裡不需要提及. 因為對它基本上無法進行黑盒測試,它既不是輸入也不是輸出,而且跟這兩者也沒有什麼聯絡。

讓我們用「數字輸出端變化的頻率應控制在每秒10次和每秒1次之間」來代替自由運 行定時器的測試標準。

• 對於上述的第四條需求,可能需要一些小修改才能作為測試標準。讓我們用「adc端的輸入電壓應當保證在每100毫秒內至少被讀取一次」來加以描述,這樣的描述能讓我們預期的測試行為顯得更加通俗易懂。

• 需求的第五條也需要一些小修改。我們如何才能檢測電壓的輸出範圍是在0到1伏之間呢? 總不能給個2伏的電壓,然後看看元器件有沒有被燒毀吧?

那麼,說「檢驗系統在adc端輸入電壓為1到2伏之間的時候,工作是否正常」,這樣就檢驗就容易多了。需求描述應當是「正面」的,應當描述裝置「應該」的行為,而不是裝置「不應該」的行為。否則的話,測試將會無法進行。

版本0.2

1. 數字輸出端的切換頻率應當控制在每秒10次到每秒1次之間

2. 數字輸出端的切換頻率應當在最大值和最小值之間呈線性變化,並與adc端的輸入電壓成正比

3. adc端的輸入電壓應當保證在每100毫秒內至少被讀取一次

4. 檢驗當adc端的輸入電壓範圍在0到1伏之間的時候,系統工作是否正常

第七步:你的需求是否通俗易懂?

相比於我們原來的描述:「根據彎曲感測器的輸出不同頻率來控制led閃爍」,我們上面的那些需求描述顯得難以閱讀和理解。

我發現,讓需求文件變得通俗易懂,最簡單辦法莫過於,把過於細節的東西抽取出來,然後以條目的形式單獨定義。

版本12. 切換led的狀態,使其與彎曲感測器的讀數保持一致

3. 當彎曲感測器的讀數為1伏特時,led狀態切換的次數應當保持在平均一秒十次;當感測器的讀數為0伏特時,led的切換次數應保持在一秒1次。

定義:• led狀態:數字狀態由y端輸出

這樣就好多了(儘管還不完美)。這些需求通俗易懂,不涉及到系統內部實現,且易於測試。對於系統行為的限定也僅僅限於需要做什麼,點到為止。(例如,對彎曲感測器的取樣頻率,在實現上也可以更高,只要不產生非預期行為,一切都可以)。

編寫需求就彷彿是在大腦中構建軟體的過程。因此要重於執行操作。

如何編寫優質的需求文件

全屏閱讀 收藏 英文原文 how to write good requirements 編寫需求文件,在嵌入式開發領域是非常普遍的。需求文件被用來定義開發任務,協調大規模的研發計畫。對於最終的產品,需求文件扮演著開發者行為和消費者行為之間溝通紐帶的角色。當需求文件書寫正確的時候,便可以發揮巨大的作用...

需求文件的編寫

需求的寫作形式一般分為兩種,物件導向和面向過程。對於不同的受眾和應用,採取不同的形式。面向過程的形式 主要的思想是ipo的原則,也就是 輸出 處理 輸出 文件格式,一 首先是對於整體系統的簡略介紹 目的,確定文件描述的物件和大體內容 二 系統上下文,介紹系統和其他系統之間的關係,邊界如何劃分 三 系...

編寫產品需求文件

1做好準備工作 你需要去了解你的顧客 競爭對手 產品團隊的實力和需要的技術。你需要從顧客 使用者 競爭對手 分析師 產品團隊 銷售隊伍 市場 公司職員等收集他們能發現的問題和可能的解決辦法。這裡有很多的工作需要你去完成,在 成功的產品背後 這篇文章中有詳細的描述。2確定產品的目的 注意你不需要闡述太...