公开建站实验 M1 需求规格

目标收益

通过 M1 实现能展示文章的站点，让管理员可以维护文章。

范围

按 公开建站实验 Charter & Kickoff 计划：

1. 实现内容的管理和分发；
2. 内容结构：实现自动TOC、边注、对话；
3. 内容视图：实现阅读进度、可转发子标题、对话、美观的代码块；

工作重点是有亮点的文章展示。

概念和术语

1. TOC

   Table of Content

2. 边注

   Margin Note

用户和权限

系统架构

架构图

暂略

业务流

1. 访客 -> 查看文章
2. 访客 -> 登录
3. 非管理员用户 -> 查看文章
4. 非管理员用户 -> 登录
5. 非管理员用户 -> 退出
6. 管理员 -> 登录
7. 管理员 -> 退出
8. 管理员 -> 查看文章
9. 管理员 -> 文章管理 -> 新增文章
10. 管理员 -> 文章管理 -> 编辑文章
11. 管理员 -> 文章管理 -> 删除文章
12. 管理员 -> 文章管理 -> 分发文章

数据流

暂略

数据字典

见数据模型

ER图

见数据模型

功能需求

REQ001-显示文章

用户在浏览器打开一篇文章的网址，浏览器显示这篇文章，含标题、作者、发布日期、更新日期。

REQ002-显示文章-自动TOC

用户在浏览器打开一篇文章的网址，浏览器显示这篇文章时，还会显示这篇文章的TOC。

REQ003-显示文章-边注

用户在浏览器打开一篇文章的网址，浏览器显示这篇文章时，还会显示这篇文章的边注。

REQ004-显示文章-对话

用户在浏览器打开一篇文章的网址，浏览器显示这篇文章时，还会显示这篇文章中的对话。

REQ005-显示文章-阅读进度

用户在浏览器打开一篇文章的网址，浏览器显示这篇文章时，还会显示这篇文章的阅读进度。

REQ006-显示文章-可转发子标题

用户在浏览器打开一篇文章的网址，浏览器显示这篇文章时，可方便转发子标题。

REQ007-显示文章-美观的代码块

用户在浏览器打开一篇文章的网址，浏览器显示这篇文章时，以美观的方式显示代码块。

REQ008-新增文章

管理员在登录后，在浏览器打开新增文章界面，通过新增文章界面可新增文章。

REQ009-新增文章-对话

用户在浏览器打开管理界面，新增文章时，可方便插入对话。

REQ010-编辑文章

管理员在登录后，在浏览器打开编辑文章界面，通过编辑文章界面可编辑文章。

REQ011-删除文章

管理员在登录后，在浏览器打开文章列表界面，通过文章列表界面可删除文章。

REQ012-查询文章

管理员在登录后，在浏览器打开文章列表界面，会打开最近10篇文章，通过查询框，可查询文章。

REQ013-登录

任意用户可在登录界面登录。

REQ014-退出

已登录用户可退出登录。

软硬件及外部系统接口

人机界面

基于 Web 提供基础的界面。直观、简洁。

硬件需求

具有网络协议栈软件，并能运行现代浏览器访问互联网的设备。

运行环境

现代浏览器：Chrome、Edge、Safari、Firefox 及任何支持 HTML5 与 CSS3 标准的浏览器。 标准分辨率：1024*768、1920*1080、2K

非功能需求

可靠性

系统主要能力与服务器与网络设备、服务端应用可靠性有关。

可用性

性能

1. 并发：非交易系统，并发无要求。本建站实验计划使用 Rust 作为后端，最大并发用户数按 Host 性能而定。
2. 常规页面响应速度 2s 以内。

安全性需求

浏览器端与服务端交互的数据，使用 SSL 进行信息交换，少量长连接场景客户端与服务端使用二进制协议通讯。