概要设计说明书

1引言

1.1编写目的

为了帮助用户更好的了解和使用本在线表格，提高用户与软件的亲和度。 用户手册描述配置和使用改在线表格，以及该软件使用过程中应该注意的一下问题。

1.2背景

说明：

1. 本用户手册所描述的软件系统的名称为：基于协同在线表格；
2. 该软件项目的任务提出者：企业
3. 该软件项目的开发者：*******
4. 用户（或首批用户）：企业。

1.3定义

在线协同表格：一个功能丰富，配置简单的在线表格组件，开箱即用。

Jest：Jest 可帮你实现无痛的 JavaScript 单元测试支持。

JavaScript：JavaScript是一种具有函数优先的轻量级，解释型或即时编译型的编程语言。

TypeScript：TypeScript是微软开发的一个开源的编程语言，通过在JavaScript的基础上添加静态类型定义构建而成。

React：React是用于构建用户界面的JavaScript库。

1.4参考资料

列出有关的参考文件，如：

1. 腾讯文档（苍穹-TencentDoc）集成使用手册；
2. 百度文档集成使用手册；；
3. [1]左紫欢. 软件测试过程可视化的研究与应用[D].西南科技大学,2022.DOI:10.27415/d.cnki.gxngc.2022.000960.
4. [1]王秀艳.软件测试过程管理系统的设计与实现[J].电子技术与软件工程,2020(24):46-47.。

2总体设计

2.1需求规定

说明对

本系统的主要的输入输出项目、处理的功能性能要求，详细的说明可参见附录C。

功能	输入	处理	输出
注册	用户基本信息	添加到数据库	用户基本信息
添加管理员	管理员基本信息	添加到数据库	管理员基本信息
书写文档	输入数据	查询到数据库	编辑记录

2.2运行环境

Windows XP及以上系统

2.3基本设计概念和处理流程

2.4软件体系结构

2.5功能器求与程序的关系

本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：

	管理端	用户端
用户基本信息	√	√
基本操作	√	√

2.6人工处理过程

说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。

2.7尚未问决的问题

数据库中多个表与功能实现的详细不够全面，大体关系已掌握，后续优化中。

3接口设计

3.1用户接口

说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。

命令	语法	信息回复
确定	Ok,click事件，默认键Enter	实现输入的命令
查询	Click事件	出现查询的内容
修改	Click事件	点击
清除	Click事件	清空界面中数据
取消	Cancel，Click事件，点击	取消对数据的修改

3.2外部接口

报表部分：连接打印机

输出Excel表

3.3内部接口

客户端通过配置数据源与服务器建立连接。系统内部与数据库接口链接。

4运行设计

4.1运行模块组合

1. 管理员模块：修改表格权限，管理用户信息，数据库的调用与修改。
2. 用户：编辑修改文档，修改密码，查询进度数据库的调用与修改。

4.2运行控制

用户登录时需要进行身份认证，用户名，密码和数据库中的一直且根据不同而登录不同的环境。

管理员登陆之后可以对系统进行修改。

4.3运行时间

每个操作反应时间不超过0.5秒。

5系统数据结构设计

5.1逻辑结构设计要点

用户信息（User_lnfo）

名称	标识符	数据类型	长度
用户名	UserID	Char	10
状态	Status	Char	10
级别	Level	Char	10
登陆时间	LoginTime	Char	10

操作信息

名称	标识符	数据类型	长度
文档名称	FileNO	Char	10
操作者	User	Char	10
编辑时间	Ontime	Char	10

5.2物理结构设计要点

给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。

5.3数据结构与程序的关系

说明各个数据结构与访问这些数据结构的形式:

由客户端输入的信息存入服务端的数据库中，访问方式根据操作人员而定。

6系统出错处理设计

6.1出错信息

错误类型	错误提示
输入信息错误	输入错误，请重新输入
无选择条件，就进行查询或修改	请选择要查询或者修改的信息
程序运行错误	程序运行错误

6.2补救措施

1. 采用后备技术，当原始系统数据丢失时启动副本建立和启动技术，由于数据库中已经有备份，故在系统出错后可以依靠数据库的恢复功能
2. 恢复及再启动技术，使软件从故障点恢复执行或使软件从头开始

6.3系统维护设计

各个程序之间的对应关系，可采用如下的矩阵图的形式；由于系统较小没有外加维护模块，所以维护工作较为简单，仅对数据库做一些基本维护即可。