设计文档更新

docs/概要文档/软件设计描述说明书(SDD).md

@@ -0,0 +1,106 @@
+# 软件设计描述说明书(SDD)
+
+## 1. 引言
+
+### 1.1 目的
+本文档的目的是描述智能编辑器网站的软件设计和架构，为开发团队提供实施指南，并向项目利益相关者展示设计决策的详细情况。
+
+### 1.2 范围
+本文档涵盖智能编辑器网站的整体架构、组件设计、数据设计、接口设计以及其他必要的系统集成相关的设计方面。
+
+### 1.3 定义、缩写和缩略语
+- **MPA**: 多页面应用
+- **API**: 应用程序接口
+- **OCR**: 光学字符识别
+
+### 1.4 参考资料
+- [软件需求规格说明书（SRS）](软件需求规格说明书%20(SRS).md)
+- [项目计划说明书](项目计划说明书.md)
+- [相关标准和规范说明书](标准规格说明书.md)
+
+### 1.5 概述
+本文档后续章节将详细描述软件的架构设计、模块设计、数据设计、接口设计、安全设计、性能设计、可扩展性和可维护性设计等内容。
+
+## 2. 参考模型
+
+### 2.1 软件架构图
+提供智能编辑器网站的高层架构图，并简要描述每个组件的功能。
+- 前端：基于Vue 3的多页面应用
+- 后端：基于SpringBoot 3的RESTful API
+- 数据库：PostgreSQL，用于存储用户数据和文档数据
+- 第三方服务：集成OCR和语音到文本转换API
+
+### 2.2 技术栈
+- 前端：Vue 3、Vue Router、Vuex
+- 后端：SpringBoot 3、Spring Security等
+- 数据库：PostgreSQL
+- 中间件：Redis（用于缓存）、RabbitMQ（用于消息队列）
+- 云服务：使用云服务提供OCR和语音到文本转换API
+
+## 3. 细节设计
+
+### 3.1 模块设计
+
+#### 3.1.1 用户管理模块
+- **模块名称**: 用户管理模块
+- **责任**: 负责用户注册、登录、权限管理等功能
+- **接口描述**: 提供用户注册、登录、注销、获取用户信息、修改用户信息等接口
+- **依赖关系**: 依赖数据库存储用户信息
+- **处理流程**: 用户通过前端界面进行操作，后端处理并返回结果
+- **异常处理**: 处理用户已存在、密码错误等异常情况
+
+#### 3.1.2 文档管理模块
+- **模块名称**: 文档管理模块
+- **责任**: 负责文档的创建、编辑、保存和管理
+- **接口描述**: 提供文档创建、编辑、保存、删除、获取文档列表等接口
+- **依赖关系**: 依赖数据库存储文档数据
+- **处理流程**: 用户通过前端界面进行操作，后端处理并返回结果
+- **异常处理**: 处理文档不存在、保存失败等异常情况
+
+#### 3.1.3 润色和格式排版模块
+- **模块名称**: 润色和格式排版模块
+- **责任**: 提供文本润色和格式排版功能
+- **接口描述**: 提供文本润色、格式排版等接口
+- **依赖关系**: 依赖第三方API进行文本润色和格式排版
+- **处理流程**: 用户提交文本内容，调用第三方API进行处理，返回处理结果
+- **异常处理**: 处理API调用失败、文本处理失败等异常情况
+
+### 3.2 数据设计
+
+#### 3.2.1 数据库设计
+- 描述数据库模式，包括ER图、表结构、索引策略、关系完整性约束等。
+
+> 请参考 [设计文档-数据库设计文档](/设计文档/数据库设计文档)
+
+#### 3.2.2 数据流设计
+- 描述数据流向和处理的方式，可以使用数据流图来辅助说明。
+
+### 3.3 接口设计
+
+#### 3.3.1 外部接口
+- 详细说明系统与外部系统交互的接口，包括API端点、数据格式、通信协议等。
+
+> 请参考 Apifox 设计文档
+
+#### 3.3.2 内部接口
+- 描述系统内部各组件间的接口规范。
+
+## 4. 其他设计
+
+### 4.1 安全设计
+- 描述如何保证软件的安全性，包括认证、授权、加密等策略。
+- 使用Spring Security进行用户认证和授权
+- 数据传输采用HTTPS协议，保证通信安全
+- 用户密码采用 Base64/BCrypt 进行加密存储
+
+### 4.2 性能设计
+- 描述系统的性能目标和设计考虑，如并发处理、缓存策略、负载均衡等。
+- 使用Redis进行缓存，提高数据访问速度
+- 使用RabbitMQ进行消息队列处理，提升系统并发能力
+- 采用负载均衡策略，确保系统在高并发情况下的稳定性
+
+### 4.3 可扩展性和可维护性设计
+- 描述设计中考虑的扩展性和可维护性方面，如模块化程度、代码重用等。
+- 采用微服务架构设计，方便模块的独立开发和部署
+- 使用Docker进行容器化部署，提高系统的可移植性和部署效率
+- 采用CI/CD（持续集成/持续部署）流程，确保代码的高质量和快速迭代