tzxblog博客系統-需求及立項說明

v1.0

項目背景

這是一個模擬的博客系統,利用業餘時間開發,旨在鞏固整個軟件開發週期內的各項流程,以開發技術練習爲主,文檔和工具練習爲輔。力求重要的流程都有文檔可以追溯、關鍵的技術點都有筆記進行記錄。
由於之前實現的功能選擇的部分技術並非主流,因此本次算是對原項目的優化和重構。再由於之前並沒有完整的流程,因此本次實際也可以看成是一個全新的項目。


項目流程說明

項目預計可練習的流程有:

需求和立項說明

這裏的需求旨在對項目整體背景和功能進行說明,作爲項目開發的基本指導,不交付標準的需求文檔,需求和立項相關內容暫時合二爲一,輸出簡單的指導文檔。

概要設計

整體概要設計應當對前後端各項技術、架構、基本功能流程及異常有所說明,輸出概要設計文檔。

數據庫設計

數據庫設計應當包含基本的數據字典說明,也應該包含基本的數據初始化sql,輸出對應的文檔。

接口設計

接口設計主要用於前後臺對接,需要標明請求方式、URL、入參、出參、錯誤碼等,輸出接口API文檔

框架搭建

框架搭建包含前端項目搭建和後端項目搭建,此過程應當對關鍵點有所記錄和整理以及存檔,使要點可回顧,代碼可複用。

項目開發

項目開發過程中應當注意和概要設計的一致性,以版本迭代方式,需兼顧功能和性能以及代碼的可讀性、可拓展性、規範性。

功能測試

功能測試應當對照需求功能說明輸出測試用例和測試工具及腳本使用說明。

性能測試

性能測試應當輸出性能測試腳本和工具使用說明。

部署文檔

項目部署需要輸出部署文檔,對部署方式是否自動化,各中間件的安裝、配置及初始化進行說明。

用戶手冊

用戶手冊用於指導最終軟件的功能使用,原則應該是簡單易懂。

版本說明

各輸出文檔均以迭代方式進行,需在每次變更時明確修改版本號並進行版本說明。


功能需求說明

首頁

首頁以四欄式佈局,分爲頭部導航、下方左側分類信息、下方中間內容列表區域和下方右側推薦等信息區域。
頭部導航包括回到首頁、博客、下載、登錄按鈕,點擊可跳轉到具體的功能頁面。
點擊分類信息的具體選項,需要展示出具體分類下的內容列表,以時間倒序排列。
點擊內容列表區域需要跳轉到具體的文章頁面。
推薦區域需求待定。

個人首頁

首頁以常用三欄式佈局,分爲頭部導航、下方左側基本信息和下方右側內容列表區域。
頭部導航包括回到首頁、博客、下載、登錄、寫博客按鈕,點擊可跳轉到具體的功能頁面。
基本信息應當包括個人信息、分類信息、存檔等。
內容列表區域展示個人博客分類,點擊具體列表項跳轉到文章詳情頁面。

文章詳情

文章詳情頁需要實現基本的文檔展示以及評論和編輯,要能支持markdown語法。

下載功能

點擊導航的下載需要跳轉下載頁面,展示可供下載的資源列表,並提供下載和上傳以及文件在線預覽功能。

評論功能

文章詳情支持評論,評論實現郵件推送功能,同時實現登陸後的消息通知。


項目地址

項目代碼和文檔均以github託管,地址如下:
https://github.com/tuzongxun/tzxblog

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章