如何編寫優質的需求文檔?

03-01

盡量簡短

沒有比這更重要的文檔寫作建議了。簡潔意味著清晰的思路和溝通，也意味著你的文檔更加易於閱讀和理解——這一點至關重要。

使用平白的語言和簡單的格式

使用簡短而不是花哨的語句，使用列表和加粗強調可以使文章更一目了然，以放鬆有趣的方式寫作而不是一板一眼，如果你有得體的幽默感就再好不過了。

為開發團隊預留時間

通過評審並且達成一致通過的文檔才是完善的文檔。如果你希望在未來的某一個迭代 Sprint 中開發此項目，就應該提前兩到三周開始這個產品文檔寫作流程。

像工程師一樣思考

在項目得以進入開發之時，常常會發現大量未預料到的邊緣情況——但這種情形其實可以避免。如果你認真考慮過項目進入開發的所有必要條件，你就可以提前發現這些問題（例如，是否在移動設備中可以使用在線聊天功能？）。

確保每一個人都跟上了你的節奏

當我組織產品評審時，會議室里的大部分人都已經大致了解我要講的內容——因為我已經提前在討論會和日常聊天中溝通過這個事情了。既然大家都已經清楚了「做什麼」和「為什麼要做」的問題，文檔評審會上我們只要關注實施細節就好了。

在圖表中下功夫

流程圖、線框圖等圖表可以通過易於理解的方式提供很大的信息量，同時也需要消耗非常多的時間來製作這些圖表。

在思考和寫文檔上花 0.5-3 天時間

具體時間根據項目大小而定。花費在寫文檔上的時間越長，所帶來的邊際收益就會遞減。特別需要指出的是，沒有人能夠讀的下去超過 5-6 頁的文檔。

指明方向，明晰願景

你不僅僅是在定義一個功能，也是在解釋「為什麼我們要做這件事情」以及「我們的目標是什麼」，在文檔中指出這個項目將會對更高層面的規劃造成什麼影響，以及接下來會發生什麼。

確保你的觀眾閱讀了文檔

如果你的文檔又臭又長，或者從來不分享給對應的人，那你還不如不寫文檔。務必確保你的文檔被對應的人閱讀了，我上面關於評審開始時留時間給大家讀文檔的建議值得大家參考。

獲取真誠的反饋

你的文檔是否是在贅述人盡皆知的事情？或者是文檔缺乏足夠的細節？是否在後續實施中發現了太多的邊緣情況？又或者，是否在制定計劃和文檔評審上耗費了太多的時間？你應該和你的團隊時刻保持溝通。