好的產品需求文檔擁有6個共性

0 評論 7939 瀏覽 19 收藏 8 分鐘

編輯導讀:寫產品需求是產品經理最常做的工作之一,它考驗的是一個產品經理的基本功,因為產品需求文檔算得上是產品經理的半個大腦。如何書寫一份可讀性高的需求文檔呢?本文作者從自身工作經驗出發,總結了六點細節,與你分享。

“不專業的產品經理,你連ta需求文檔都讀不下去”,這是近期很有共鳴的一句話,產品需求文檔算得上是產品經理的半個大腦,因為產品需求文檔是前期所有工作的結果,那一份可讀性高的需求文檔到底有哪些共性?

首先先了解我們大腦是怎么理解文字或一段話的,我們遇到事情需要去理解時就會將得到的信息往已知的模型上靠,一旦如果我們大腦有類似模型,理解起來就很容易。如果沒找到類似的模型,理解就很困難。

一、聲明名詞,幫助閱讀者建立已知模型

為什么提到Toast大家知道是提示對話框,因為Toast已經被多次教育大腦已經“定義”好了,大腦能直接解析并獲得信息。但如果需求文檔中經常出現的或者陌生的詞,就可以在文檔開頭定義清楚,這樣一來就能讓閱讀者清晰明白,這個常出現或者陌生的詞到底是什么意思。有點類似于紙質書里面的注釋,避免理解誤差,達成共識。

二、用開發熟悉的語言來寫文檔

網上經常會有人問,開發喜歡看怎樣的需求文檔,用戶開發熟悉的語言來寫,即一些邏輯描述和開發平時常接觸描述一致,如開頭所提到,往開發已知的信息模型上靠,比如一個列表的排序規則,我們想描述時間越近排在越前的時候,通常會這么寫“XXX按動態更新時間從大到小排序”,最好的應該這么描述是“按更新時間倒序”,“倒序/升序/降序”應該已經存在每個開發人員的已知信息模型中,理解起來更容易。

除了排序外比較常見的還有時間單位,可以用yyyy-MM-dd hh:MM:ss即年月日時分秒來代替,相比文字描述研發對字母代碼更熟悉。

三、結構化圖文搭配

如果一個頁面需求比較復雜且是純文字描述性的文字,一大坨一大坨堆在一起別說開發人員,就算是你接手了離職同事的文檔,相信你也看不不下去,能用圖來描述的情況下就不要用文字,圖+文字搭配可讀性會更高,一圖勝千言,因為實際開發時,開發需要考慮后續邏輯變化,如果只有純描述性的文字,開發可能還得猜后續邏輯變化,但如果有流程圖/泳道圖搭配文字描述,那結果就完全不一樣了。

四、善用表格

如果一個需求涉及“一對多”或者“多對多”的時候,比如根據“不同用戶等級給予不同的文案提示”,用表格把“等級和對應提示文案”裝起來,真的會有一目十行的效果。我們得感謝有“表格”這種東西存在,因為如果沒有表格,我們可能得多喝5L水和開發面對面溝通,估計后續還得在微信上敲5000個字。

五、巧用公式

公式是最常見的邏輯處理之一,涉及到一些加減乘除的計算邏輯,盡可能公式化來描述需求,這樣能簡化開發的理解和思考。比如我們在描述積分變化情況時,通常喜歡用純描述性的文字來寫文檔,“點擊簽到按鈕用戶積分加1,點擊抽獎按鈕用戶積分-20”

如果把純描述性文字轉換成公式化變成以下這樣:

  • “點擊簽到按鈕 用戶積分 = 總積分 + 1”
  • “點擊兌換按鈕 用戶積分 = 總積分 – 20 ”

是不是更加直觀更符合開發語言。

但是記得不要“得寸進尺”,如果覺得自己一定開發基礎,還想進一步提高開發人員閱讀效率,是不是可以寫成“偽代碼”直接給開發照貓畫虎。個人不建議這么做,因為不同開發語言寫法都不一樣,你理解的語言在開發角度可能不容易理解,我以前就犯過一個錯誤,web端的彈窗alert,在Android端得用AlertDialog安卓開發才容易理解,不然還得理解你這個alert才能轉化自己的思路,并且需求文檔閱讀人員里面還包含了測試人員,就算開發理解了,測試不一定會理解。

一些能被復用的產品模塊,盡可能保持同樣的寫法,如果描述的畫風不一樣,開發有可能給你做出不一樣的東西,當然上面所提到的內容,均建立在邏輯沒有硬傷的前提下。

六、持續進步

可以去看一下部分框架和平臺的開發文檔,比如web端常見的Ant Design,Element,如果產品形態是小程序可以去看微信小程序開發文檔等等, 這樣能夠了解框架/平臺的更新日志,這種信息了解的越多,對技術理解越深入,這樣不管是寫文檔還是和開發溝通都會有很大幫助,同時這也是洞察力的一種表現。因為部分新能力更希望是你來提醒開發,這樣開發更有積極性來響應,而不是平臺更新了某個功能你毫不知情,反過來開發來提醒你,就顯得非常被動。

切勿硬生生套用模板!

經常會有一些讀者加微信后會問“園長,你有PRD模板嗎”,模板只是面上的東西,對于新人來說,模板只能給自己提供一個思路,而不是全部套用,畢竟合適自己的才是最好的,所以最好的模板內容模塊應該是內部多次實操后總結出來的。

#專欄作家#

動物園園長,微信公眾號:首席吹牛官,個人網站:http://chiefbragger.com/,人人都是產品經理專欄作家。互聯網圈十八線作詞人,國家一級退堂鼓表演藝術家。顏良而文丑,歡迎交流。

本文原創發布于人人都是產品經理。未經許可,禁止轉載

題圖來自Unsplash,基于CC0協議

給作者打賞,鼓勵TA抓緊創作!
更多精彩內容,請關注人人都是產品經理微信公眾號或下載App
評論
評論請登錄
  1. 目前還沒評論,等你發揮!