撰寫后臺需求文檔需要注意的那些事兒

產品老司機手把手教寫文檔,10天線上課程,零基礎掌握產品經理必備7大文檔撰寫法。了解一下>

很多產品經理在撰寫后臺的需求文檔時會一臉懵,很多時候不知道怎么開始,這篇文章主要根據自己工作中對后臺的理解和需求文檔撰寫經驗進行分享。

人員較小的公司,會要求產品經理后臺管理和前臺界面一起進行撰寫。那么,我們在撰寫后臺需求文檔時,需要對于后臺有一定的了解。當然,要是技術轉型做產品經理,對于這一塊可以說是有優勢。

產品經理要是技術小白,我們需要對后臺有一定的了解并指導技術常用的詞語,需要知道相應的后臺的組成部分和作用。

在撰寫后臺需求文檔時,要先將前臺界面確定下來,最好和對應的人員確定好,開個需求評審會,將界面和業務明確。之后再開始后臺需求文檔的撰寫,以我的親身經歷告訴你,修改是很麻煩的。

我們要知道一點,前臺界面和對應的后臺的界面字段要一致。因為數據庫需要設計表,改動較大,后臺的接口也需要調整,這樣開發同學會很煩,要重新寫接口。

?一、后臺作用(后臺是干什么的)

后臺主要是管理整個系統軟件,就像你是學生,需要去學校一樣,學校就是管理你的。

不管是APP還是PC,都有一個管理后臺,我們在寫后臺需求文檔時需要記住四字秘訣“增刪改查”,這是最核心的東西。

就用PC網站來說,一個PC網站上線后臺需要準備哪東西呢?

首先,域名和服務器。

域名和服務器必須買,域名還需要備案,不然就發布不了。做完第一步就需要進第二步,環境搭建,這個技術會解決,感興趣的可以了解一下后臺常見的環境部署,主要有nginx,tomcat,還有第三方的工具,都可以使用。環境搭建完成就是配置文件,將你的配置文件放在購買的服務器的環境目錄下面,找到對應文件進行配置就可以訪問了。

后臺對前端界面的設置和管理,這是最大的作用。我們需要對后臺的業務非常熟悉,在產品設計的時候就不會亂七八糟一堆。如果后臺邏輯混亂,頁面流程不夠流暢,你就是在挖坑,后面接手的產品經理會天天問候你的。

在撰寫后臺需求文檔時,始終記著“增刪改查”,每一個功能和頁面都需要有這四點,這樣你后面進行需求文檔復查時錯誤會很少。在設計后臺之前,需要將對應的人員角色進行充分的考慮和對應的場景進行分析。除了功能層面的增刪改查還有一定的人員權限,如果權限不做特殊要求,也可以使用增刪改查的方式進行設計。

注意:后臺的模塊需要進行劃分合理,不然擴展維護比較困難。

建議:不要在公司正式的服務器環境進行操作,可以多和后臺人員和運維人員進行溝通。

二、后臺構成(后臺關鍵的幾個組件)

后臺最核心的主要是數據庫、接口、服務器環境,我們從簡單的三個方面進行,在這里就用大白話說明這三個東西的作用。

數據庫:數據的存儲,常用的數據庫是MySQL,SqlServer,Oracle。體量較小使用的是MySQL數據庫,數據庫包含的信息有字段和表以及權限等。

數據庫就是倉庫,我們APP中數據用戶信息都是在數據庫中進行存儲。不同的信息會對應不同的表,這個表需要開發人員進行設計,對應的結構需要合理,不然數據多的時候就會影響APP的使用體驗。

比如,有個表單你需要看,然后后臺進行查詢,結果查詢數據太多,導致結果顯示慢,用戶可能需要等待幾分鐘才能看見相應數據。這種體驗很差。

接口:接口中包含一定的信息數據,定義對應的返回值,更多的是我們前端界面請求后臺接口時需要返回一定的參數,其中包含對應成功失敗等的狀態。

包含的信息和數據帶著對應字段的信息,接口展示的形式是url地址,拿到這個地址進行解析,最后你會看見對應包含的信息在里面。

前端界面進行請求接口,也就是url地址,地址中會返回一定的參數,可以拿個接口在線解析看一下。

環境:后臺需要一定的環境,沒有環境就無法正常運行。一般環境分為正式環境和測試環境,環境的搭建主要是后臺開發人員或者是運維部署。

可以手動嘗試搭建對應的后臺環境,測試一下,理解其中的原理,就會明白軟件運行的原理。搭建環境需要專業的安裝工具,百度上面有很多教程,具體的步驟:首先買服務器,其次域名進行備案,最后將服務器環境進行部署。阿里云上面有詳細的教程,感興趣可以看以對應的環境搭建。

建議:查看一下數據庫,最好是親自進行操作,可以嘗試一下免費的數據庫測試(測試數據庫的地址https://demo.phpmyadmin.net/master-config/)。

注意:對應的數據庫表設計要合理,前期架構時將對應的模塊進行分類,后期進行擴展。

三、文檔怎么寫

文檔撰寫的流程和邏輯以及實現的思路,我們這里就用一個人員管理來進行說明:需求是人員的管理,包含人員的信息、登錄、注冊、開通、修改編輯、刪除、查詢,主要包含信息就是增刪改查。

1. 確定需求

后臺是根據前臺界面來的,前臺界面展示一個人員的信息,這個人名字就叫A;A的信息有姓名、崗位、部門、電話、開通日期、郵箱。

前臺的信息已經確定,我們后臺的信息也就可以確定,從新增功能點進行說明:

  • 新增:姓名、崗位、部門、電話、開通日期、郵箱。
  • 全權限設置:分配對應的權限,將權限設置好。
  • 點擊提交,這條數據就會在數據庫存在。

建議:細小的功能將其模塊化,就像一個人一樣,整體是一個人,其中手眼睛鼻子等是身體的組件部分,產品也可以從小的組件進行組裝。

2. 主要功能點

將對應的主要的功能點進行羅列,并且對應的細節需要考慮到和其他業務之間的關聯,以下就將對應核心功能點進行羅列:

  • 查詢:支持類型為姓名、手機號、崗位和部門
  • 狀態管理:正常、凍結
  • 賬戶管理:新增、修改、刪除
  • 分頁加載:頁面數據、分頁加載對應數據
  • 查看:個人信息查看、密碼查看(建議設置點擊空白區域三下查看)

建議:對應的功能點中細小的信息進來羅列,這樣后期方便權限的分配。

注意:密碼可見最好是先和管理人員確定,將可見狀態設置權限。

3. 業務說明

業務的說明需要將對應的跳轉,也注意事項仔細的進行說明。就像新增每個字段,我們支持對應的類型和不支持類型。

提交狀態是否要求全部輸入內容,沒有輸入內容按鈕就不可進行點擊提交,這樣的說明我們需要一點一點添加進去。

首先,將業務流程進行思考清楚,對應的人員和對應的操作流程,這樣你后期需求文檔頁面就是完整的。

如果業務流程不清楚,就從單獨的功能點開始進行。將頁面的布局進行點擊,多點擊幾次,就會發現頁面流程是不是完整,對應的需求是不是能夠完整走完。

其次,如果需求太多實在理解不來,就一個一個進行拆分,務必將需求盡可能的理解到位,不然就會面臨很大的改動。

最后,理解核心的流程。我們有時候會接收到一堆的需求和流程,但是流程太多會不容易理解,很多時候需求提出者更多的是口述,所以需要多問對方再確定。

建議:需求太多就用手機錄下來。

注意:理解的偏差,再三確定需求,重要的事情說三遍。

?總結

后臺需求文檔需要將能放在一起的產品前端界面就放在一起,這樣我們后期維護起來就方便。如果你的后臺和對應的前臺界面一樣,那么這樣的是不合理的。

在撰寫后臺的時候,需要將對應前臺功能點進行整理。就像你看到的APP前臺界面,想想后臺的邏輯是怎么實現的。

最后,在撰寫前臺界面的時候,可以將對應的后臺功能點一起進行撰寫。當然實在覺得自己搞不了,在寫文檔的的時候,就多問問你們的后臺大哥。

最后,附上一張自己做的項目結構圖,包含前端和后臺:

 

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

題圖來自Unsplash,基于CC0協議

給作者打賞,鼓勵TA抓緊創作!
評論
歡迎留言討論~!
  1. 我把你名字看成了李坑

    哈哈

    回復
  2. 有部分寫的挺亂的 不過這個文章還是挺有用的

    回復
    1. 謝謝您

      回復
  3. 沒有哪句話說的不對,但是全文和配圖和標題之間都很混亂不通…

    回復
    1. 下次會找個高大上的圖

      回復
  4. 這個開發后臺的都懂

    回復
    1. 啊哈

      回復
  5. 后臺需求設計的核心在于基礎數據與應用之間的分層與結構設計。

    回復
    1. 大佬一針見血

      回復
    2. 大佬可以具體講講嗎

      回復
马总会三肖中特