用户手册(GB8567——88)
1引言
1.1编写目的
为了帮助用户更好的了解和使用本在线表格,提高用户与软件的亲和度。 用户手册描述配置和使用改在线表格,以及该软件使用过程中应该注意的一下问题。
1.2背景
说明:
- 本用户手册所描述的软件系统的名称为:基于协同在线表格;
- 该软件项目的任务提出者:企业
- 该软件项目的开发者:********
- 用户(或首批用户):企业。
1.3定义
在线协同表格:一个功能丰富,配置简单的在线表格组件,开箱即用。
Jest:Jest 可帮你实现无痛的 JavaScript 单元测试支持。
JavaScript:JavaScript是一种具有函数优先的轻量级,解释型或即时编译型的编程语言。
TypeScript:TypeScript是微软开发的一个开源的编程语言,通过在JavaScript的基础上添加静态类型定义构建而成。
React:React是用于构建用户界面的JavaScript库。
1.4参考资料
列出有用的参考资料,如:
- 腾讯文档(苍穹-TencentDoc)集成使用手册;
- 百度文档集成使用手册;;
- [1]左紫欢. 软件测试过程可视化的研究与应用[D].西南科技大学,2022.DOI:10.27415/d.cnki.gxngc.2022.000960.
- [1]王秀艳.软件测试过程管理系统的设计与实现[J].电子技术与软件工程,2020(24):46-47.。
2用途
2.1功能
1. 数据收集方便迅速:创建者、填写人员使用统一个表,不占用多余空间,好管理易查找;很多在线表格软件还提供表单形式,供用户填写信息且无需下载;
2.数据修改同步更新:信息有变化填写人员自行修改即可,其他人员不必重新填写,表格管理者查看到的是修改后的新数据;
3.数据安全加密功能:用户每一步对数据进行的编辑修改操作、组织变更等内部行为,都能被安全记录在云端,甚至一些软件对每行每列的修改权限都有明确的划分。
2.2性能
2.2.1精度
本基于协同的在线表格支持小数,整数等各种运算组合,超限时会以科学技术法显示,亦支持精度更改。
2.2.2时间特性
响应时间:迅速
更新处理时间:根据用户反应速度以及网路速度而定
数据传输:快速。
2.2.3灵活性
用户操作方式:pc端用户可通过键鼠方式输入,也可使用数位板;移动端用户可通过触控方式及手写方式输入。
运行环境:联网环境下。
时间特性:运行环境的改变不影响软件的响应时间以及数据传输速率。
2.3安全保密
用户之间不能相互修改密码,即各用户只有登陆自己的账户才能修改自己的密码;
各用户只能在自己的权限范围内操作,无法实现越权的任何操作,实现了数据的安全与保密。
3运行环境
3.1硬设备
运行本在线表格所要求的硬设备的最小配置:
- 处理机的型号:Pentium11即以上;
- 内存容量512M及以上;
- 所要求的外存储器50GB及以上;
- 其他设备:鼠标,键盘;
- 操作系统:。
3.2支持软件
运行本软件所需要的支持软件:
- 操作系统:Windows98及以上;
- 社交类软件如:QQ,微信,企业微信等
- 浏览器:Edge,safari等。
3.3数据结构
支持本软件的运行所需要的数据库:MongoDB,版本号:6.0.1
字段名 |
数据类型 |
描述 |
id |
String |
表格id |
name |
String |
表格名 |
row |
Int32 |
行 |
column |
Int32 |
列 |
config |
Document |
样式 |
pivotTable |
Boolean |
表格关联 |
status |
Int32 |
状态码 |
select_range |
Array |
选区范围 |
zoomRatio |
Int32 |
缩放 |
celldata |
Array |
表内数据 |
4使用过程
在本章,首先用图表的形式说明软件的功能同系统的输入源机构、输出接收机构之间的关系。
4.1安装与初始化
本项目为基于协同的在线表格,无需专门安装软件。
4.2输入
按需输入,可创建在线表格,拟定模板,而后生成URL,其他用户可通过此URL同时访问编辑改表格。
4.2.1输入数据的现实背景
A、项目进度归档,添加,修改,查询,删除;
B、班级人员个人信息的统计;
C、企业员工报表。
4.2.2输入格式
名称 |
标识 |
数据类型 |
值示例 |
属性值 |
安全保密 |
|
单元格值格式 |
celltype |
String |
{"fa":"General", "t": "g" } |
ct |
中 |
|
背景颜色 |
background |
String |
#fff000 |
bg |
中 |
|
字体 |
fontfamily |
String |
微软雅黑 |
ff |
中 |
|
字体颜色 |
fontcolor |
String |
#fff000 |
fc |
中 |
|
粗体 |
bold |
String |
|
bl |
中 |
|
斜体 |
italic |
String |
0 常规1斜体 |
it |
中 |
|
字体大小 |
fontsize |
String |
14 |
fs |
中 |
|
删除线 |
cancelline |
String |
0 常规 、 1 删除线 |
cl |
中 |
|
下划线 |
underline |
String |
0 无 、 1 有 |
un |
中 |
|
垂直对齐 |
verticaltype |
String |
0 中间、1 上、2下 |
vt |
中 |
|
水平对齐 |
horizontaltype |
String |
0 居中、1 左、2右 |
ht |
中 |
|
合并单元格 |
mergecell |
String |
主单元格{ r:0, c:0, rs: 2, cs:2 },辅单元格{ r:0, c:0 } |
mc |
中 |
|
竖排文字 |
textrotate |
String |
3 |
tr |
中 |
|
文字旋转角度 |
rotatetext |
String |
介于0~180之间的整数,包含0和180 |
rt |
中 |
|
文本换行 |
textbeak |
String |
0 截断、1溢出、2 自动换行 |
tb |
中 |
|
原始值 |
value |
String |
|
v |
中 |
|
显示值 |
monitor |
String |
|
m |
中 |
|
公式 |
function |
String |
|
f |
中 |
|
批注 |
comment |
String |
height: 140,//批注框高度 |
ps |
中 |
4.2.3输入举例
学生信息表:
19200233789,张三,性别,计科,江苏苏州
4.3输出对每项输出作出说明
4.3.1输出数据的现实背景
说明输出数据的现实背景,主要是:
- 使用——企业员工,协同工作;
- 使用频度——每周定期的上报工作进度;
- 媒体——智能设备,鼠标,键盘;
- 质量管理—一语法检验、使用函数时可纠错;
- 支配——创建在线文档的用户具有管理员权限,可添加管理员。
4.3.2输出格式
名称 |
标识 |
数据类型 |
值示例 |
属性值 |
安全保密 |
|
单元格值格式 |
celltype |
String |
{"fa":"General", "t": "g" } |
ct |
中 |
|
背景颜色 |
background |
String |
#fff000 |
bg |
中 |
|
字体 |
fontfamily |
String |
微软雅黑 |
ff |
中 |
|
字体颜色 |
fontcolor |
String |
#fff000 |
fc |
中 |
|
粗体 |
bold |
String |
|
bl |
中 |
|
斜体 |
italic |
String |
0 常规1斜体 |
it |
中 |
|
字体大小 |
fontsize |
String |
14 |
fs |
中 |
|
删除线 |
cancelline |
String |
0 常规 、 1 删除线 |
cl |
中 |
|
下划线 |
underline |
String |
0 无 、 1 有 |
un |
中 |
|
垂直对齐 |
verticaltype |
String |
0 中间、1 上、2下 |
vt |
中 |
|
水平对齐 |
horizontaltype |
String |
0 居中、1 左、2右 |
ht |
中 |
|
合并单元格 |
mergecell |
String |
主单元格{ r:0, c:0, rs: 2, cs:2 },辅单元格{ r:0, c:0 } |
mc |
中 |
|
竖排文字 |
textrotate |
String |
3 |
tr |
中 |
|
文字旋转角度 |
rotatetext |
String |
介于0~180之间的整数,包含0和180 |
rt |
中 |
|
文本换行 |
textbeak |
String |
0 截断、1溢出、2 自动换行 |
tb |
中 |
|
原始值 |
value |
String |
|
v |
中 |
|
显示值 |
monitor |
String |
|
m |
中 |
|
公式 |
function |
String |
|
f |
中 |
|
批注 |
comment |
String |
height: 140,//批注框高度 |
ps |
中 |
4.3.3输出举例
学生信息表:
19200233789,张三,性别,计科,江苏苏州
- 定义:学生基本信息收集
- 来源:班级学生用户
- 特性:人员自行填写。
4.4文卷查询
表名 |
查询 |
学生信息表 |
学号和姓名模糊查询 |
项目进度表 |
员工号和模块名模糊查询 |
4.5出错处理和恢复
具备格式检查,输入字符会提示错误,重新输入。
4.6终端操作
略。