PLUB 框架:產品文檔結構 MDVC 框架升級版
最近在和朋友做另外一個項目的時候,相互之間溝通需求的過程中,在需求文檔結構上有了比較深入的探討。在幾輪的探討過程中,發現自己寫過的一篇相關文章——MDVC框架:產品文檔最優雅的結構——其中介紹的產品文檔相關框架的不足和漏洞,因此,補上一篇,特此糾正。
在前一版本中(1.0)講述的 MDVC 模型主要涉及到:模型(Model)——數據(Data)——視圖(View)——交互(Controller)等內容,在升級的框架版本(2.0)中,也包含了對 1.0 版本中的內容,不但調整了產品需求文檔內容的結構,還新增了後台(Backstage)以及後端(Back-End)的部分邏輯;另外,也涉及到描述文檔內容的邏輯。
該篇文章的主要有以下部分組成:
1. MDVC 框架存在不足2. PLUB 框架相關介紹那我們就開始吧!
就像任何框架或者理論早期都會存在一定的局限和不足,MDVC 框架也沒能避開,依然存在一定的不足和局限。當然,這也是我對自己階段性認知的總結,也證明了我在一年前提出的 MDVC 框架表現出自己的不足。也希望,在此次調整中,希望能夠給大家啟發,同時,整理我自己的思路。
MDVC 框架的適用範圍問題 核心問題:過於狹窄。
MDVC 框架結構較易適用於與開發溝通對接,但不利於與設計師、其他相關人員溝通。跳出工作的範圍考慮,更加不適於第一次接觸項目以及產品文檔的人。比如,外包團隊的設計師、開發、產品經理等等。MDVC 框架不能讓非相關人員在短期內,較快的了解項目和產品。
舉個例子,MDVC 框架只是從功能的角度介紹了產品邏輯,但並沒有從界面數量介紹項目和產品。在和外包設計,甚至是內部設計師溝通的時候,這部分的工作會帶來一些不必要的溝通成本;比如,外包設計師並不知道界面的數量有多少,界面中對應的狀態都多少。優秀的外包設計以及內部設計師,能夠幫助你去梳理,但蹩腳的設計師,特別是外包設計,基本上是按照頁面數量收費的,可想而知,不明細的界面數量以及對應界面的提示狀態,會導致一定的時間成本以及資金成本的消耗。再舉個例子,針對客戶端開發以及後端開發,MDVC 框架介紹項目以及產品需求較分散,並沒有從一個功能的角度出發,在滿足客戶端開發了解需求的基礎上,也考慮後端開發以及後台的需求,導致一個功能需要和客戶端、後端分別做開發需求溝通。MDVC 框架的邏輯條理問題
核心問題:比較混亂,不清晰。在適用範圍的基礎上,延伸出了邏輯條理的這個問題。因為一個項目以及對應的產品需求,在大多數情況下,每隔界面中都會有或多或少的交叉。因為有交叉,對文檔的邏輯就會有比較高的要求。而 MDVC 框架並沒有很好的解決這個問題。導致一個功能的某些邏輯甚至是全部邏輯會重複在文檔中出現。而這一問題,不但給產品經理帶來不小的問題,也會給項目以及產品等的相關人員帶來不必要的麻煩。邏輯條理混亂、不清晰的另外一個表現是在產品文檔結構上。採用怎樣的結構,更高效地對產品需求進行梳理和介紹,對相關人員理解掌握需求也是十分重要的。MDVC 框架中產品需求的結構是採用模型-數據-視圖-交互的方式,這種方式的靈活性較差,而且在實際的應用中需要在各環節之間有較多的跳躍。這樣,就會很難連貫地閱讀理解產品需求,有時候還會出現紕漏。MDVC 框架的維護成本問題
核心問題:維護難度大。結合以上兩個問題,我發現 MDVC 框架在當下以及未來,維護需求和文檔都存在較大的隱患。一方面是因為框架的適用範圍,以及框架邏輯條理問題,導致後期維護人員需要耗費比較多的時間理解項目和需求;另一方面,在跨部門(公司)合作過程中,溝通的成本也非常大。基於以上 MDVC 框架存在的問題,我對該框架進行了調整,提出了 PLUB 框架。
P = Page
解決 MDVC 框架中界面(頁面)數量的問題,方便相關人員從全局了解整個項目的情況。同時,能夠讓設計師以及開發了解所設計的界面以及界面中對應的全部狀態,並且評估相應的工作量。另外,需要提及的一點是,因為界面的唯一性,在規划過程中不會或者儘可能減少界面中相同或者相似邏輯的存在,能夠減少工作中的交叉邏輯。L = Logic
解決 MDVC 框架中的結構關係,並增加集中的邏輯關係描述。介紹界面中以及界面之間的邏輯關係,包括核心、非核心邏輯關係。核心關係包括:登錄/未登錄狀態下,各界面中對應的狀態;各界面中每種狀態的觸發邏輯;達到/未達到相關條件的時候,對應的處理方式;是否需要通過後端/後台配置;是否需要通過後端/後台控制是否展示(雲控);等等。非核心邏輯關係包括:界面中的UI,某些元素是否需要通過後端/後台配置,比如某個需要頻繁更換的 Tab icon 以及名稱;界面中的點擊跳轉關係(交互);界面中點擊 icon 相關的交互展示;等等。U = UI&UE
這部分中,並不需要像 MDVC 一樣,需要單獨的結構進行介紹,是貫穿在邏輯部分的核心以及非核心邏輯中的。單獨提出來,是希望在撰寫產品需求文檔中,要考慮根據邏輯部分的調整,隨時對規劃中的 UI/UE 進行調整。B = Back-End&Backstage
在撰寫需求文檔過程中,在 MDVC 框架中,只是對數據來源作了簡要的提及,但並不深入;同時也影響了對文檔相關的項目和產品的閱讀和理解。在 PLUB 框架中,B 部分同樣也融合在邏輯結構中。當介紹界面中某一功能的時候,能夠將該功能從頭到尾,有比較全面的介紹。後台以及後端部分包括協議(介面)以及後台產品的規劃邏輯。在 PLUB 框架結構文檔的開篇,你可以適當增加版本以及界面邏輯關係圖,那樣不管是初步了解項目以及產品的相關人員,甚至是在跨部門(公司)的合作中,多會給你們節省一定的成本——時間以及資金方面,當然,還會讓你和合作者之間收穫無形的資產,建立良好的合作關係。
接下來,我通過適用 PLUB 框架,給大家做一個實例:
實例介紹
某產品錢包界面以及相關邏輯。進入錢包界面時,檢查用戶是否登錄;
- 個人信息區域
用戶未登錄狀態下展示未登錄logo並提示引導用戶登錄,提示文案「首次登錄送紅包,最高可得 200 元哦!」;
未登錄狀態下,點擊個人信息區域,從該界面從下到上推出登錄界面;登錄界面見界面20;登錄狀態展示默認頭像以及用戶昵稱,昵稱處理方式為手機號第4-7位預設表示,如:132****4147;登錄狀態下,個人信息區域點擊無跳轉界面 - 現金、金幣、徒弟區未登錄狀態下對應數據表示為0.00、0、0;點擊現金、金幣、徒弟任一位置,從該界面從下到上推出登錄界面;(界面20)登錄狀態下,展示當前用戶現金、金幣、徒弟數額;點擊現金區域,跳轉到收支明細現金界面;(界面9)點擊金幣區域,跳轉到收支明細金幣界面;(界面9)點擊徒弟區域,跳轉到我的徒弟界面(界面13)
- 簽到打卡
未登錄狀態下顯示「連續簽到送紅包」,展示每次簽到應該獲得的金幣額度;簽到按鈕為高亮狀態;
未登錄狀態下點擊簽到按鈕,從該界面從下到上推出登錄界面;登錄界見界面20;登錄狀態下展示當前最新的連續簽到次數,顯示「您已連續簽到 x 天」。登錄狀態下未簽到,簽到按鈕表示為「簽到」狀態,用戶可點擊簽到按鈕; 登錄狀態下已簽到,簽到按鈕表示為「已簽到」狀態。每次簽到完成後,如果是金幣,在當前界面提示用戶簽到獲得金幣彈窗,同有效閱讀資訊獎勵彈窗一致,並展示所獲得金幣獎勵,3s後消失;如果是紅包,簽到完成後,在當前界面提示獲得簽到紅包彈窗,在簽到紅包獎勵彈窗時,點擊關閉,彈窗消失;點擊賺取更多,跳轉到首頁(界面2)。用戶點擊簽到完成後,「您已經連續簽到 x+1 天」,同時簽到進度也增加一個。(給用戶發放獎勵)
每天簽到獲得一次獎勵;
每天連續簽到才能獲得下一次獎勵;非連續簽到,不會獲得下一次獎勵,將從第1次開始計算;簽到每連續7天循環一次;每天簽到獎勵類型、獎勵額度均可以在後台配置。如果是金幣,前端顯示數量,如果是紅包,前端顯示紅包圖標。- 整點紅包 活動未開啟時,按鈕位置展示到下一次活動開啟的倒計時,不可點擊; 活動開啟時,並且是在有效時間內(有效時間為10分鐘,後台可配置),按鈕顯示為「搶紅包」狀態,可點擊,如果超過10分鐘,顯示下一次的倒計時;
未登錄狀態下,點擊「搶紅包」按鈕,從該界面從下到上推出登錄界面;登錄界見界面20;
登錄狀態下,點擊「搶紅包」按鈕,提示獲得限時紅包獎勵彈窗。後台可配置紅包時段,以及每個時段的獎勵類型與獎勵額度(現金額度是一個區間,金幣是10的倍數)。如果是金幣,顯示金幣彈窗,3s後消失;如果是紅包,顯示紅包彈窗,點擊關閉按鈕,關閉彈窗;點擊賺取更多,跳轉到首頁(界面2)。(給用戶發放獎勵)- 曬收入獎勵未登錄,按鈕狀態表示為「馬上曬」,點擊按鈕,從該界面從下到上推出登錄界面;(界面20);已登錄,如果用戶當天已經領取過獎勵,按鈕狀態顯示「已領取」,不可點擊;如果用戶當天還未領取過曬收入獎勵,按鈕狀態表示為「馬上曬」,點擊按鈕,跳轉到曬收入拿金幣界面;(界面11);
需要判斷用戶是否有效完成曬收入,完成給用戶發放獎勵,如果是金幣,金幣彈窗,3s消失,如果是現金,彈窗告訴用戶,點擊關閉,彈窗消失,點擊賺取更多,跳轉到首頁界面2;
曬收入獎勵類型以及獎勵額度,後台可配置;(給用戶發放獎勵) - 額外閱讀獎勵用戶當天有效閱讀資訊或者視頻內容(給獎勵次數)次數達到後台配置的次數,給予用戶獎勵,獎勵類型與數量後台可配置。未登錄狀態下,文案顯示「今天累計閱讀30次可領取xxx金幣/xxx元」,按鈕狀態為「立即領取」,點擊按鈕;從該界面從下到上推出登錄界面;登錄界見界面20;已登錄狀態,判斷用戶當天的閱讀次數是否達到後台配置的要求:?如果未達到,文案顯示「再閱讀xx次就可以領取獎勵,加油」;按鈕顯示「繼續閱讀」; 點擊按鈕,跳轉到首頁(界面2)。如果已達到,文案顯示「恭喜您完成xx次閱讀,立即領取獎勵吧」,按鈕顯示「立即領取」,點擊按鈕,根據獎勵類型進行彈窗,如果是金幣,金幣彈窗,3s消失,如果是現金,彈窗告訴用戶,點擊關閉,彈窗消失,點擊賺取更多,跳轉到首頁界面2;; (給用戶發放獎勵)
備註:界面+數字:表示在整體界面數量中的位置
推薦閱讀: