什么樣的開發文檔可稱之為「完美」?
首先為大家鋪墊一些定義,一般情況下,我們所說的「開發文檔」指的是「產品開發文檔」,而作為一名創業者,你還應該準備好其他的文檔內容。
產品需求文檔(PRD)
產品由“需求”階段到“開發“階段的最主要的文檔,產品需求文檔將對設計部門、研發部門乃至測試部門的工作起到指導、量化的作用,因此文檔的質量至關重要。
市場需求文檔(MRD)
產品由“需求”階段到“開發“階段的第一份文檔,是對產品在市場層面的說明,多描述核心用戶、購買者、客戶的真實需求,也是公司在戰略意圖上的實現。市場需求文檔不僅要體現出產品的「高度」,還要為產品開發、運營推廣指出明確的方向。
商業需求文檔(BRD)
這份文檔是產品在開發之前,企業高層作決策評估的重要依據。其內容涉及市場分析及規劃,營銷策略及投入,盈利預測等,通常是演示文檔的形式,短小精煉,沒有產品細節,比較像一份商業計劃書。
了解好全部的定義后,我們來討論如何制作一份「完美」的產品需求文檔(PRD)。
什么是「完美」的產品需求文檔?
從閱讀者的角度出發,「完美」代表著文檔格式規范、文字嚴謹、可讀性高。
這三點看起來很容易就做到,但實際上,這需要對細節有著最強烈的追求。
格式規范
所有文檔均使用統一排版,頁眉、字體、字號、顏色,表格規范,圖片大小一致
善用加粗、斜體及項目符號等格式,使得文檔更具有邏輯性,更清晰,重點內容更突出
禁用大段文字,更多的使用表格、流程圖等,建議大家學習和使用UML的相關知識,用例圖、類圖、序列圖、活動圖、狀態圖等,可以清楚詳細的描繪出任何一種事物和各種邏輯關系。
文字嚴謹
?文檔名稱需要高度概括且精確的命名,使項目同事迅速了解文檔的內容
?每一個重要的名詞必須附帶定義,以便使所有同事都能明白其內容,有時做錯比沒做還要更麻煩
文檔中出現的專業術語需要撰寫文檔的人先理解含義,否則別寫在文檔中。開發文檔最終的目的是指導開發工作,并不一定必須使用最專業的術語,把產品邏輯講清楚即可
可讀性高
?重要性和優先級需要著重考慮,整體文檔內容如何布局,有些內容優先需排在前列,有些內容不需要寫進文檔之中,這要求的是撰寫人站在閱讀人的角度和立場考慮問題
?產品開發文檔需做到全面性,這包含兩方面。一方面,我們需要將每一條需求的所有可能性展現出來;一方面,文檔的閱讀者可能包含設計、研發、測試等眾多部門,需要考慮到他們不同的關注點
?整體文檔富有邏輯,層層深入,環環緊扣,使用數據或案例來輔助你所表達的內容
總結一下,制作產品需求文檔最核心的理念是:這不是做給誰看的工作,這是將指導團隊所有人工作的工作。抱有著這樣的想法,就可以理解“需求文檔是為了團隊服務的”這個觀點,就可以做到以上那些細節之處,就可以離「完美」更進一步。
APICloud提供免費一對一需求梳理的服務
由專業監理制作詳細、完善的「開發文檔」
www.bjsjct.com