從零開始做一款應(yīng)用,最讓人頭疼的往往不是技術(shù)實(shí)現(xiàn)有多難,而是需求文檔寫完后,開發(fā)到一半發(fā)現(xiàn)邏輯走不通,測試階段發(fā)現(xiàn)場景沒覆蓋,上線前夕又冒出新的業(yè)務(wù)規(guī)則,導(dǎo)致整個(gè)項(xiàng)目反復(fù)返工。其實(shí),需求文檔的核心價(jià)值不是“寫得多全”,而是“讓所有參與方對同一件事的理解一致”。只要方法得當(dāng),完全可以把反復(fù)修改的次數(shù)降到最低。
先別急著寫功能,先搞清楚“為什么做”
很多需求文檔一上來就寫“首頁要有搜索框”“個(gè)人中心要有訂單列表”,但真正導(dǎo)致反復(fù)修改的,往往不是這些表面功能,而是背后的業(yè)務(wù)目標(biāo)沒有講清楚。如果團(tuán)隊(duì)不知道這個(gè)功能要解決什么問題,開發(fā)時(shí)就會按自己的理解補(bǔ)邏輯,測試時(shí)會按自己的標(biāo)準(zhǔn)判斷對錯(cuò),后期自然會不斷調(diào)整。
因此,文檔開頭必須明確:這個(gè)應(yīng)用要服務(wù)哪些用戶?他們在什么場景下遇到問題?當(dāng)前問題如何影響效率、成本或體驗(yàn)?目標(biāo)達(dá)成后如何衡量?這些內(nèi)容不需要寫得很長,但必須能讓產(chǎn)品、設(shè)計(jì)、開發(fā)和測試在同一頁上對齊。只有目標(biāo)清晰,后續(xù)的功能取舍才有依據(jù),而不是靠臨時(shí)討論決定。
把用戶場景寫具體,而不是只列功能清單
需求文檔最容易踩的坑,就是把功能當(dāng)成需求。比如寫“支持用戶下單”,這只是一個(gè)結(jié)果,真正需要描述的是:用戶從哪里進(jìn)入、看到什么信息、如何填寫、遇到錯(cuò)誤怎么辦、提交后狀態(tài)如何變化、失敗后能否重試、數(shù)據(jù)如何保存。
更穩(wěn)妥的方式是按角色和場景拆分。比如普通用戶、管理員、審核人員各自會做什么操作;正常流程是什么;異常流程如何處理;邊界情況如何判斷。每一個(gè)場景都要能還原成一條完整路徑,而不是零散的功能點(diǎn)。這樣開發(fā)時(shí)才知道接口怎么設(shè)計(jì),測試時(shí)才知道用例怎么覆蓋,后期修改時(shí)也能判斷影響范圍。
用流程圖把關(guān)鍵路徑畫出來
文字再詳細(xì),也比不上一張清晰的主流程圖。對于復(fù)雜業(yè)務(wù),最好把核心鏈路畫出來,例如注冊登錄、下單支付、內(nèi)容發(fā)布、審核上架、消息通知、狀態(tài)流轉(zhuǎn)等。流程圖不需要追求美觀,但必須能回答幾個(gè)問題:從哪里開始?經(jīng)過哪些判斷?成功走哪條路?失敗走哪條路?最終狀態(tài)是什么?
流程圖的價(jià)值在于暴露邏輯缺口。很多時(shí)候,文字描述看起來完整,但一畫流程就會發(fā)現(xiàn):某個(gè)狀態(tài)沒有出口,某個(gè)判斷沒有默認(rèn)值,某個(gè)環(huán)節(jié)缺少權(quán)限控制。這些問題如果在文檔階段被發(fā)現(xiàn),修改成本很低;如果等到開發(fā)階段才發(fā)現(xiàn),就可能牽一發(fā)而動(dòng)全身。
每個(gè)功能都要寫清輸入、處理、輸出
需求文檔中每一個(gè)功能模塊,都應(yīng)該盡量結(jié)構(gòu)化??梢园础坝|發(fā)條件、前置條件、頁面元素、交互規(guī)則、數(shù)據(jù)規(guī)則、后端處理、返回結(jié)果、異常提示、權(quán)限要求、埋點(diǎn)需求”這樣的框架來寫。這樣寫的好處是,開發(fā)不會漏接口,測試不會漏用例,設(shè)計(jì)也不會憑空猜測交互。
比如一個(gè)提交操作,不能只寫“用戶點(diǎn)擊提交后保存數(shù)據(jù)”,而要說明:哪些字段必填,哪些字段有長度限制,是否允許重復(fù)提交,網(wǎng)絡(luò)異常時(shí)如何處理,保存成功后頁面如何反饋,失敗后是否保留已填內(nèi)容,數(shù)據(jù)是否需要二次校驗(yàn),是否觸發(fā)后續(xù)流程。越具體,后期爭議越少。
狀態(tài)和規(guī)則必須閉環(huán)
應(yīng)用開發(fā)中,最容易反復(fù)修改的地方往往是狀態(tài)。比如訂單有新建、待支付、已完成、已取消、已退款等狀態(tài),如果文檔只寫了正常流程,沒有寫狀態(tài)之間的轉(zhuǎn)換條件,開發(fā)就會自行補(bǔ)規(guī)則,測試也會按不同理解執(zhí)行,最終必然出現(xiàn)不一致。
所有狀態(tài)都要明確:從哪個(gè)狀態(tài)來,滿足什么條件才能進(jìn)入下一個(gè)狀態(tài),是否允許回退,回退后數(shù)據(jù)如何變化,用戶會看到什么提示,后臺是否需要記錄日志。業(yè)務(wù)規(guī)則也一樣,不能只寫“滿足條件即可通過”,而要寫清條件的具體判斷方式、優(yōu)先級、默認(rèn)值和沖突處理辦法。
把非功能需求也寫進(jìn)文檔
很多團(tuán)隊(duì)只關(guān)注功能是否實(shí)現(xiàn),卻忽略了性能、安全、兼容、數(shù)據(jù)、權(quán)限、日志、埋點(diǎn)等非功能需求。等到開發(fā)后期再補(bǔ),往往需要重構(gòu)接口或調(diào)整架構(gòu)。