tzxblog博客系统-需求及立项说明

v1.0

项目背景

这是一个模拟的博客系统,利用业余时间开发,旨在巩固整个软件开发周期内的各项流程,以开发技术练习为主,文档和工具练习为辅。力求重要的流程都有文档可以追溯、关键的技术点都有笔记进行记录。

由于之前实现的功能选择的部分技术并非主流,因此本次算是对原项目的优化和重构。再由于之前并没有完整的流程,因此本次实际也可以看成是一个全新的项目。


项目流程说明

项目预计可练习的流程有:

需求和立项说明

这里的需求旨在对项目整体背景和功能进行说明,作为项目开发的基本指导,不交付标准的需求文档,需求和立项相关内容暂时合二为一,输出简单的指导文档。

概要设计

整体概要设计应当对前后端各项技术、架构、基本功能流程及异常有所说明,输出概要设计文档。

数据库设计

数据库设计应当包含基本的数据字典说明,也应该包含基本的数据初始化sql,输出对应的文档。

接口设计

接口设计主要用于前后台对接,需要标明请求方式、URL、入参、出参、错误码等,输出接口API文档

框架搭建

框架搭建包含前端项目搭建和后端项目搭建,此过程应当对关键点有所记录和整理以及存档,使要点可回顾,代码可复用。

项目开发

项目开发过程中应当注意和概要设计的一致性,以版本迭代方式,需兼顾功能和性能以及代码的可读性、可拓展性、规范性。

功能测试

功能测试应当对照需求功能说明输出测试用例和测试工具及脚本使用说明。

性能测试

性能测试应当输出性能测试脚本和工具使用说明。

部署文档

项目部署需要输出部署文档,对部署方式是否自动化,各中间件的安装、配置及初始化进行说明。

用户手册

用户手册用于指导最终软件的功能使用,原则应该是简单易懂。

版本说明

各输出文档均以迭代方式进行,需在每次变更时明确修改版本号并进行版本说明。


功能需求说明

首页

首页以四栏式布局,分为头部导航、下方左侧分类信息、下方中间内容列表区域和下方右侧推荐等信息区域。
头部导航包括回到首页、博客、下载、登录按钮,点击可跳转到具体的功能页面。
点击分类信息的具体选项,需要展示出具体分类下的内容列表,以时间倒序排列。
点击内容列表区域需要跳转到具体的文章页面。
推荐区域需求待定。

个人首页

首页以常用三栏式布局,分为头部导航、下方左侧基本信息和下方右侧内容列表区域。
头部导航包括回到首页、博客、下载、登录、写博客按钮,点击可跳转到具体的功能页面。
基本信息应当包括个人信息、分类信息、存档等。
内容列表区域展示个人博客分类,点击具体列表项跳转到文章详情页面。

文章详情

文章详情页需要实现基本的文档展示以及评论和编辑,要能支持markdown语法。

下载功能

点击导航的下载需要跳转下载页面,展示可供下载的资源列表,并提供下载和上传以及文件在线预览功能。

评论功能

文章详情支持评论,评论实现邮件推送功能,同时实现登陆后的消息通知。


项目地址

项目代码和文档均以github托管,地址如下:
https://github.com/tuzongxun/tzxblog

推荐文章