修改提交

fantastic-editor · May 13, 2024 · 91d9e33 · 91d9e33
1 parent a9466d7
commit 91d9e33
Show file tree

Hide file tree

Showing 9 changed files with 53 additions and 18 deletions.
diff --git a/docs/favicon.png b/docs/favicon.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,32 @@
-# OnlineEdit
+# 妙笔智编
 
-> 这是
+> 妙笔智编，一个结合大小AI模型技术，通过百度飞桨AI Studio和文心ERNIE SDK开发的在线文档编辑器，旨在提高用户处理多模态信息的效率，实现智能润色、多媒体信息提取和智能格式排版等功能，以优化学习和工作体验。
+
+## 名字由来
+
+> 妙笔智编「FantasticEditor」这个名字由两个部分组成：妙笔、智编。每个字都承载了特定的含义，体现了产品的特色和功能。
+
+
+
+1. **妙笔(Fantastic)**
+
+	- **含义**：在中文里，“妙笔”常用来形容非凡的写作才能或者能够创作出高质量文本的工具。这里的“妙笔”象征该编辑器能够帮助用户以出色和高效的方式进行写作和内容创作。
+
+	- **象征意义**：强调该编辑器不仅仅是一个简单的文本工具，更是一个能够激发用户创造力和提升写作质量的智能助手。
+
+2. **智编(Editor)**
+
+	- **含义**：“智编”指的是智能编纂或智能编辑，强调了产品的智能化特性。它表明这款编辑器能够利用人工智能技术，如自动润色、格式排版、内容整合等，来帮助用户更高效地处理和编排内容。
+
+	- **技术层面**：体现了编辑器结合了现代AI技术，尤其是在处理多模态信息（文本、图像、视频等）方面的高级能力，能够自动化许多复杂的编辑任务。
+
+## 面向对象
+
+妙笔智编是一个企业面向公众进行开发的一套基于大小 AI 模型技术「通过“百度飞桨 AI Studio ”和“文心 ENGINE ”」的在线可分享的文档编辑器，旨在提高用户处理多模态信息的效率，实现智能润色、多媒体信息处理等等，增加用户使用便利程度和优化学习和工作体验。
+
+## 系统框架设计
+
+- **前后端分离架构**：使用现代的Web开发技术栈，前端使用 `Vue3` 构建用户界面，后端采用或 `SpringBoot3-Kotlin` 实现API服务。
+- **关系数据库设计**：使用 `PostgreSQL` 作为关系数据库管理系统，存储非区块链数据，如用户信息、登录日志等。
+- **非关系数据库设计：**: 使用 `Redis` 作为非关系数据库管理系统，存储需要高读写的内容。
+- **云服务架构**：使用多种基于云服务技术栈「如百度飞桨、文心一言模型、DogeCloud 等」进行二次集成开发，降低代码的编写成本并提高使用访问体验。
diff --git a/docs/概要文档/plan.md b/docs/概要文档/plan.md
diff --git a/docs/概要文档/index.md → docs/概要文档/赛题说明.md b/docs/概要文档/index.md → docs/概要文档/赛题说明.md
@@ -1,5 +1,3 @@
-# 赛题说明
-
 ## 赛题简介
 
 > 介绍整个赛题的实现目标、实用价值、涉及技术和整体要求

diff --git a/docs/概要文档/sdd.md → docs/概要文档/软件设计描述说明书（SDD）.md b/docs/概要文档/sdd.md → docs/概要文档/软件设计描述说明书（SDD）.md
@@ -1,5 +1,3 @@
-# 软件设计描述说明书（SDD）
-
 ## 1. 引言
 
 ### 1.1 目的
@@ -16,8 +14,8 @@
 
 ### 1.4 参考资料
 
-- [软件需求规格说明书（SRS）](./srs.md)
-- [项目计划文档](plan.md)
+- [软件需求规格说明书（SRS）](软件需求规格说明书%20(SRS).md)
+- [项目计划文档](项目计划文档.md)
 - [相关标准和规范文档](standard.md)
 
 ### 1.5 概述

diff --git a/docs/概要文档/srs.md → docs/概要文档/软件需求规格说明书 (SRS).md b/docs/概要文档/srs.md → docs/概要文档/软件需求规格说明书 (SRS).md
@@ -1,5 +1,3 @@
-# 软件需求规格说明书 (SRS)
-
 ## 1. 引言
 
 ### 1.1 目的
@@ -28,10 +26,18 @@
 
 ### 2.1 产品视角
 
-该产品是一个基于多页面应用(MPA)架构的web应用，后端使用Spring Boot构建RESTful API，前端使用Vue 3构建。该结构支持复杂的用户交互和多视图内容管理，适合复杂和大规模的企业级应用。
+该产品是一个基于多页面应用(MPA)架构的web应用，后端使用 `SpringBoot3` 构建RESTful API，前端使用 `Vue3` 构建。该结构支持复杂的用户交互和多视图内容管理，适合复杂和大规模的企业级应用。
+
+### 2.2 功能
 
-### 2.2 产品功能
+#### 2.2.1 基本功能
+- **用户中心**：用于系统的用户管理的相关操作。
+- 权限管理：用于定义用户的相关权限信息。
+- 会员管理：用于定义用户的会员相关内容、用户的一些增值服务之类的操作。
+- 模板仓库：用于用户可以快速进行文档的创建、添加一些模板，增加用户友好程度。
+- 
 
+#### 2.2.2 核心功能
 - **智能润色**：自动改进文本，包括摘要、翻译、语法修正等。
 - **多媒体信息提取**：从图像、视频和音频中提取文本和信息。
 - **智能格式排版**：自动应用排版样式，如字体大小和行间距。

diff --git a/docs/概要文档/项目计划文档.md b/docs/概要文档/项目计划文档.md
@@ -0,0 +1 @@
+
diff --git a/docs/设计文档/数据库设计文档.md b/docs/设计文档/数据库设计文档.md
@@ -0,0 +1 @@
+# 数据库设计文档
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,28 +1,31 @@
-site_name: OnlineEdit 开发文档
-repo_url: https://github.com/FlyCloud-Campus/DevelopDoc
+site_name: 智汇文编文档库
+site_url: https://editor.doc.x-lf.cn/
+repo_url: https://github.com/fantastic-editor/DevelopDoc
 repo_name: OnlineSchool/DevelopDoc
 copyright: Copyright &copy; 2023 - 2024 锋楪 All Rights Reserved. 版权所有
 theme:
+  logo: favicon.png
+  favicon: favicon.png
   name: material
   language: zh
   palette:
     - media: "(prefers-color-scheme)"
       primary: green
-      accent: light blue
+      accent: cyan
       toggle:
         icon: material/brightness-auto
         name: 切换亮色模式
     - media: "(prefers-color-scheme: light)"
       scheme: default 
       primary: teal
-      accent: indigo
+      accent: cyan
       toggle:
         icon: material/brightness-7
         name: 切换暗色模式
     - media: "(prefers-color-scheme: dark)"
       scheme: slate
       primary: teal
-      accent: indigo
+      accent: cyan
       toggle:
         icon: material/brightness-4
         name: 依照系统进行模式切换