个人情况说明书格式怎么写文库（软开企服开源的无忧企业文档(V2.1.3)产品说明书）

目录

1. 概述

1.1 产品简介

1.2 名词定义

2. 版本说明

3. 系统整体构架说明

3.1 架构说明

3.2 技术栈

3.3 系统运行环境要求：

4. 功能说明

4.1 企业文档登陆与退出

4.2 首页展示

4.3 文档库新建与管理

4.4 文档的下载与分享

4.5 文档的搜索

4.6 文档的新建

4.7 文本文档编辑

4.8 在线表格编辑

4.9 线框图编辑

4.10 在线脑图

4.11 文档评价

4.12 管理后台的登陆

5. 私有化部署安装

5.1 基础安装

5.2 部署项目

5.3 部署应用

1. 概述

本文档供用户了解《无忧·企业文档》 （以下简称企业文档）时参考使用。 为使您有更好的用户体验，建议您使用Chrome浏览器使用本系统。

a.产品简介

企业文档主要是针对企业用户提供在线文档、协同编辑、知识管理的基础化办公工具，产品采用B/S构架，无需客户安装特殊客户端。解决企业内部存在多种的应用，通过基础应用底座与标准化应用解决企业内部信息孤岛问题

企业文档功能覆盖场景：在线文档的私有化部署、团队协同、知识管理、在线文档识别的扩展、文档权限化管理等场景。

b.名词定义

2.版本说明

3.系统整体构架说明

a.架构说明

企业文档是软开企服推出的信息化整体解决方案的其中重要的组成部分。整体架构如图所示，整体系统是分为前台应用与后台应用两个部分。

前台：应用

后台：支撑

前台应用主要是负责企业文档的业务层面的功能，比如文档管理、文档编辑等，后台应用主要是负责企业整体的组织构架、人员角色、前端应用运行的基础环境的维护管理等。

整体平台采用微服务构架（spring cloud），逻辑架构如图所示：

b.技术栈

• 前端：VUE+Element-ui
• 后端：spring_cloud_alibaba、spring boot、Mybatis plus、Nacos、RabbitMq、Minio、
• 数据：Mysql、ElasticSearch、Redis、MariaDB（根据情况判断是否做MYsql的集群）
• 运维：K8S+docker

c.服务列表说明

d.系统运行环境要求：

• 操作系统：CenOS 7及其以上
• CPU：8核及其以上
• 内存：32G及其以上（建议生产环境根据实际用户规模考虑）
• 硬盘：根据存储的内容的容量考虑

4.系统功能及操作说明

a.企业文档登陆与退出

• 产品体验地址：http://knowledge.bctools.cn/
• 登陆界面，登陆组件集成了账号、用户名密码、二维码、手机动态验证码4种登陆方式
• 登陆支持用户名密码登陆

• 支持公众号扫码登陆（前提：需配置自有公众号）

• 支持短信注册登陆（前提：需要对接短信网关）

b.首页展示

• 企业文档首页

首页包含帮助中心、消息中心、搜索查询、用户登录状态等功能：

• 帮助中心如图所示：

• 用户搜索：

• 点击logo，可以返回到首页

c.文档库新建与管理

• 文库新建基础配置

• 权限设置与转移文库设置

文档的权限分为所有者、管理者、阅读者，管理者有修改编辑的权限，所有者对文档有增删改查的权限、管理者有增、改、查的权限、阅读者只有查看的权限。

• 文库内容的展示

• 左侧是文库内的所有资源文件

• 右侧包含协同参与人员

• 文库的基础设置

设置可以对文档名称、说明、文库权限等内容进行配置。

• 文库下载等操作：

点击下载按钮：

系统为了保证平台的稳定性，对文库的下载时，系统自动压缩成zip文件进行下载，目前大小限制2个G。

d.文件目录的管理

文件目录管理是按照树形结构进行层级化的管理，目录包括对目录的操作，分享状态展示，以及手动拖拽排序等

文档、文件的新建，点击“+”按钮，弹出对应操作菜单

文件的重命名，双击文件或者文件夹的名称，进入重命名状态

点击目录或者文件，可以手动拖拽文件的排序

文件的操作菜单，鼠标移至文件或文件夹的“…”按钮，点击弹出操作菜单

带有分享标志的，表示该文件处于分享的状态。

e.文档的下载与分享

• 文件的预览，点击左侧文件时，右侧则将文件的内容预览展示，目前支持预览的文件，富文本文档（系统自带）、在线表格（系统自带）、在线脑图（系统自带）、在
• 线框图（系统自带），传统office （word、excel、ppt），图片以及视频等。

预览界面提供文件的存储路径，文件相关的操作、文件分享与点赞等功能。

• 点击左侧资源文件，右侧对文件进行预览展现，支持下载，分享等操作

• 文档的分享，支持无密码、有密码的分享

可以点击复制分享的URL

• 分享后的文件分享状态提示

f.文档的搜索

• 企业级搜索引擎，支持文本名称、内容的搜索

g.文档的新建

• 文档新建，点击“+”，可以直接新建文件、可以通过模板新建文件、可以通过本地计算机导入文档新建

• 新建文档方式

• 修改文档名称

• 修改文档排序，支持手动拖拽文件名称进行排序

• 通过模板新建文件，选择对应模板新建

• 模板通过管理员的角色进入到企业文档，可以对模板进行编辑修改

h.文本文档编辑

• 文档预览

• 文本文档编辑，支持名字、存储位置的手动修改

• 支持多种扩展内容展现形式，图片、代码块、表格、视频、公式、状态等，这里可以提供二次开发，定制自定义的扩展内容

• 链接配置

• 无序表、有序表、任务列表配置

• 文档保存，如下图所示，支持手动保存与快捷键保存“Ctrl+S”，保存成功后系统进行提示

i.在线表格编辑

目前基本覆盖excel主要功能，如下图所示

• 多sheet的表格

• 单元格基本格式与操作

• 单元格内容自动填充

• 单元格公式操作

• 单元格合并

• 行列相关操作

• 边框相关操作

• 冻结相关操作

• 自动换行相关操作

• 单元格内容校验相关操作

• 其他功能略

j.线框图编辑

• 流程图预览

• 流程图编辑

• 支持多种组件
• 支持自动锚点
• 支持多种图类

k.在线脑图

• 在线脑图编辑

• 支持快捷键“Tab”、“Enter”、“PgUp”、“PgDn”
• 支持专注编辑模式
• 支持修改字体颜色与背景
• 支持左右布局、自动定位居中
• 支持节点关联

l.文档评价

• 支持对文档内容进行评价与点赞

m.管理后台的登陆

管理后台主要是管理整个系统的用户账号体系、保障整体平台的文档运行所需要的运维功能等。

• 体验登陆地址：http://frame.bctools.cn/#/login

• 用户组织管理页面

• 添加组织部门

• 添加子部门或者人员

• 添加人员，员工默认密码“123456”

• 角色管理操作

• 菜单管理

5.私有化部署安装

a.基础安装

• 安装docker、docker-compose

curl -C- -O --retry 3 https://iptables.cn/file/docker/jvs-docker && chmod a+x jvs-docker && ./jvs-docker -I

• 下载项目

直接下载方式 ??https://gitee.com/software-minister/jvs-docker-compose??

• git下载方式：git clone https://gitee.com/software-minister/jvs-docker-compose.git

b.部署项目

• 部署数据库

docker-compose -f docker-compose-db.yml up -d

• 查看nacos是启动情况

# 程序依赖nacos 请保证能正常访问nacos后 再执行应用部署

curl -X GET 'http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=jvs-gateway&group=jvs&tenant=jvs'

c.部署应用

• 部署应用

# 应用启动 根据硬件情况而定 请等待几分钟

docker-compose up -d

• 访问后台http://localhost （帐号：admin 密码: admin）
• 访问知识库 http://localhost:8080?
• 测试访问nacos http://localhost:8848/nacos

无忧·企业文档体验地址：http://knowledge.bctools.cn/