撰寫后臺需求文檔需要注意的那些事兒
很多產(chǎn)品經(jīng)理在撰寫后臺的需求文檔時(shí)會一臉懵,很多時(shí)候不知道怎么開始,這篇文章主要根據(jù)自己工作中對后臺的理解和需求文檔撰寫經(jīng)驗(yàn)進(jìn)行分享。
人員較小的公司,會要求產(chǎn)品經(jīng)理后臺管理和前臺界面一起進(jìn)行撰寫。那么,我們在撰寫后臺需求文檔時(shí),需要對于后臺有一定的了解。當(dāng)然,要是技術(shù)轉(zhuǎn)型做產(chǎn)品經(jīng)理,對于這一塊可以說是有優(yōu)勢。
產(chǎn)品經(jīng)理要是技術(shù)小白,我們需要對后臺有一定的了解并指導(dǎo)技術(shù)常用的詞語,需要知道相應(yīng)的后臺的組成部分和作用。
在撰寫后臺需求文檔時(shí),要先將前臺界面確定下來,最好和對應(yīng)的人員確定好,開個(gè)需求評審會,將界面和業(yè)務(wù)明確。之后再開始后臺需求文檔的撰寫,以我的親身經(jīng)歷告訴你,修改是很麻煩的。
我們要知道一點(diǎn),前臺界面和對應(yīng)的后臺的界面字段要一致。因?yàn)閿?shù)據(jù)庫需要設(shè)計(jì)表,改動較大,后臺的接口也需要調(diào)整,這樣開發(fā)同學(xué)會很煩,要重新寫接口。
?一、后臺作用(后臺是干什么的)
后臺主要是管理整個(gè)系統(tǒng)軟件,就像你是學(xué)生,需要去學(xué)校一樣,學(xué)校就是管理你的。
不管是APP還是PC,都有一個(gè)管理后臺,我們在寫后臺需求文檔時(shí)需要記住四字秘訣“增刪改查”,這是最核心的東西。
就用PC網(wǎng)站來說,一個(gè)PC網(wǎng)站上線后臺需要準(zhǔn)備哪東西呢?
首先,域名和服務(wù)器。
域名和服務(wù)器必須買,域名還需要備案,不然就發(fā)布不了。做完第一步就需要進(jìn)第二步,環(huán)境搭建,這個(gè)技術(shù)會解決,感興趣的可以了解一下后臺常見的環(huán)境部署,主要有nginx,tomcat,還有第三方的工具,都可以使用。環(huán)境搭建完成就是配置文件,將你的配置文件放在購買的服務(wù)器的環(huán)境目錄下面,找到對應(yīng)文件進(jìn)行配置就可以訪問了。
后臺對前端界面的設(shè)置和管理,這是最大的作用。我們需要對后臺的業(yè)務(wù)非常熟悉,在產(chǎn)品設(shè)計(jì)的時(shí)候就不會亂七八糟一堆。如果后臺邏輯混亂,頁面流程不夠流暢,你就是在挖坑,后面接手的產(chǎn)品經(jīng)理會天天問候你的。
在撰寫后臺需求文檔時(shí),始終記著“增刪改查”,每一個(gè)功能和頁面都需要有這四點(diǎn),這樣你后面進(jìn)行需求文檔復(fù)查時(shí)錯(cuò)誤會很少。在設(shè)計(jì)后臺之前,需要將對應(yīng)的人員角色進(jìn)行充分的考慮和對應(yīng)的場景進(jìn)行分析。除了功能層面的增刪改查還有一定的人員權(quán)限,如果權(quán)限不做特殊要求,也可以使用增刪改查的方式進(jìn)行設(shè)計(jì)。
注意:后臺的模塊需要進(jìn)行劃分合理,不然擴(kuò)展維護(hù)比較困難。
建議:不要在公司正式的服務(wù)器環(huán)境進(jìn)行操作,可以多和后臺人員和運(yùn)維人員進(jìn)行溝通。
二、后臺構(gòu)成(后臺關(guān)鍵的幾個(gè)組件)
后臺最核心的主要是數(shù)據(jù)庫、接口、服務(wù)器環(huán)境,我們從簡單的三個(gè)方面進(jìn)行,在這里就用大白話說明這三個(gè)東西的作用。
數(shù)據(jù)庫:數(shù)據(jù)的存儲,常用的數(shù)據(jù)庫是MySQL,SqlServer,Oracle。體量較小使用的是MySQL數(shù)據(jù)庫,數(shù)據(jù)庫包含的信息有字段和表以及權(quán)限等。
數(shù)據(jù)庫就是倉庫,我們APP中數(shù)據(jù)用戶信息都是在數(shù)據(jù)庫中進(jìn)行存儲。不同的信息會對應(yīng)不同的表,這個(gè)表需要開發(fā)人員進(jìn)行設(shè)計(jì),對應(yīng)的結(jié)構(gòu)需要合理,不然數(shù)據(jù)多的時(shí)候就會影響APP的使用體驗(yàn)。
比如,有個(gè)表單你需要看,然后后臺進(jìn)行查詢,結(jié)果查詢數(shù)據(jù)太多,導(dǎo)致結(jié)果顯示慢,用戶可能需要等待幾分鐘才能看見相應(yīng)數(shù)據(jù)。這種體驗(yàn)很差。
接口:接口中包含一定的信息數(shù)據(jù),定義對應(yīng)的返回值,更多的是我們前端界面請求后臺接口時(shí)需要返回一定的參數(shù),其中包含對應(yīng)成功失敗等的狀態(tài)。
包含的信息和數(shù)據(jù)帶著對應(yīng)字段的信息,接口展示的形式是url地址,拿到這個(gè)地址進(jìn)行解析,最后你會看見對應(yīng)包含的信息在里面。
前端界面進(jìn)行請求接口,也就是url地址,地址中會返回一定的參數(shù),可以拿個(gè)接口在線解析看一下。
環(huán)境:后臺需要一定的環(huán)境,沒有環(huán)境就無法正常運(yùn)行。一般環(huán)境分為正式環(huán)境和測試環(huán)境,環(huán)境的搭建主要是后臺開發(fā)人員或者是運(yùn)維部署。
可以手動嘗試搭建對應(yīng)的后臺環(huán)境,測試一下,理解其中的原理,就會明白軟件運(yùn)行的原理。搭建環(huán)境需要專業(yè)的安裝工具,百度上面有很多教程,具體的步驟:首先買服務(wù)器,其次域名進(jìn)行備案,最后將服務(wù)器環(huán)境進(jìn)行部署。阿里云上面有詳細(xì)的教程,感興趣可以看以對應(yīng)的環(huán)境搭建。
建議:查看一下數(shù)據(jù)庫,最好是親自進(jìn)行操作,可以嘗試一下免費(fèi)的數(shù)據(jù)庫測試(測試數(shù)據(jù)庫的地址https://demo.phpmyadmin.net/master-config/)。
注意:對應(yīng)的數(shù)據(jù)庫表設(shè)計(jì)要合理,前期架構(gòu)時(shí)將對應(yīng)的模塊進(jìn)行分類,后期進(jìn)行擴(kuò)展。
三、文檔怎么寫
文檔撰寫的流程和邏輯以及實(shí)現(xiàn)的思路,我們這里就用一個(gè)人員管理來進(jìn)行說明:需求是人員的管理,包含人員的信息、登錄、注冊、開通、修改編輯、刪除、查詢,主要包含信息就是增刪改查。
1. 確定需求
后臺是根據(jù)前臺界面來的,前臺界面展示一個(gè)人員的信息,這個(gè)人名字就叫A;A的信息有姓名、崗位、部門、電話、開通日期、郵箱。
前臺的信息已經(jīng)確定,我們后臺的信息也就可以確定,從新增功能點(diǎn)進(jìn)行說明:
- 新增:姓名、崗位、部門、電話、開通日期、郵箱。
- 全權(quán)限設(shè)置:分配對應(yīng)的權(quán)限,將權(quán)限設(shè)置好。
- 點(diǎn)擊提交,這條數(shù)據(jù)就會在數(shù)據(jù)庫存在。
建議:細(xì)小的功能將其模塊化,就像一個(gè)人一樣,整體是一個(gè)人,其中手眼睛鼻子等是身體的組件部分,產(chǎn)品也可以從小的組件進(jìn)行組裝。
2. 主要功能點(diǎn)
將對應(yīng)的主要的功能點(diǎn)進(jìn)行羅列,并且對應(yīng)的細(xì)節(jié)需要考慮到和其他業(yè)務(wù)之間的關(guān)聯(lián),以下就將對應(yīng)核心功能點(diǎn)進(jìn)行羅列:
- 查詢:支持類型為姓名、手機(jī)號、崗位和部門
- 狀態(tài)管理:正常、凍結(jié)
- 賬戶管理:新增、修改、刪除
- 分頁加載:頁面數(shù)據(jù)、分頁加載對應(yīng)數(shù)據(jù)
- 查看:個(gè)人信息查看、密碼查看(建議設(shè)置點(diǎn)擊空白區(qū)域三下查看)
建議:對應(yīng)的功能點(diǎn)中細(xì)小的信息進(jìn)來羅列,這樣后期方便權(quán)限的分配。
注意:密碼可見最好是先和管理人員確定,將可見狀態(tài)設(shè)置權(quán)限。
3. 業(yè)務(wù)說明
業(yè)務(wù)的說明需要將對應(yīng)的跳轉(zhuǎn),也注意事項(xiàng)仔細(xì)的進(jìn)行說明。就像新增每個(gè)字段,我們支持對應(yīng)的類型和不支持類型。
提交狀態(tài)是否要求全部輸入內(nèi)容,沒有輸入內(nèi)容按鈕就不可進(jìn)行點(diǎn)擊提交,這樣的說明我們需要一點(diǎn)一點(diǎn)添加進(jìn)去。
首先,將業(yè)務(wù)流程進(jìn)行思考清楚,對應(yīng)的人員和對應(yīng)的操作流程,這樣你后期需求文檔頁面就是完整的。
如果業(yè)務(wù)流程不清楚,就從單獨(dú)的功能點(diǎn)開始進(jìn)行。將頁面的布局進(jìn)行點(diǎn)擊,多點(diǎn)擊幾次,就會發(fā)現(xiàn)頁面流程是不是完整,對應(yīng)的需求是不是能夠完整走完。
其次,如果需求太多實(shí)在理解不來,就一個(gè)一個(gè)進(jìn)行拆分,務(wù)必將需求盡可能的理解到位,不然就會面臨很大的改動。
最后,理解核心的流程。我們有時(shí)候會接收到一堆的需求和流程,但是流程太多會不容易理解,很多時(shí)候需求提出者更多的是口述,所以需要多問對方再確定。
建議:需求太多就用手機(jī)錄下來。
注意:理解的偏差,再三確定需求,重要的事情說三遍。
?總結(jié)
后臺需求文檔需要將能放在一起的產(chǎn)品前端界面就放在一起,這樣我們后期維護(hù)起來就方便。如果你的后臺和對應(yīng)的前臺界面一樣,那么這樣的是不合理的。
在撰寫后臺的時(shí)候,需要將對應(yīng)前臺功能點(diǎn)進(jìn)行整理。就像你看到的APP前臺界面,想想后臺的邏輯是怎么實(shí)現(xiàn)的。
最后,在撰寫前臺界面的時(shí)候,可以將對應(yīng)的后臺功能點(diǎn)一起進(jìn)行撰寫。當(dāng)然實(shí)在覺得自己搞不了,在寫文檔的的時(shí)候,就多問問你們的后臺大哥。
最后,附上一張自己做的項(xiàng)目結(jié)構(gòu)圖,包含前端和后臺:
本文由 @李杭?原創(chuàng)發(fā)布于人人都是產(chǎn)品經(jīng)理。未經(jīng)許可,禁止轉(zhuǎn)載
題圖來自Unsplash,基于CC0協(xié)議
我把你名字看成了李坑
哈哈
有部分寫的挺亂的 不過這個(gè)文章還是挺有用的
謝謝您
沒有哪句話說的不對,但是全文和配圖和標(biāo)題之間都很混亂不通…
下次會找個(gè)高大上的圖
這個(gè)開發(fā)后臺的都懂
啊哈
這個(gè)也好像不是給開發(fā)后臺的人 看的
后臺需求設(shè)計(jì)的核心在于基礎(chǔ)數(shù)據(jù)與應(yīng)用之間的分層與結(jié)構(gòu)設(shè)計(jì)。
大佬一針見血
大佬可以具體講講嗎