From a2e68bf5f9d3473b7d953077d0d2501bc2b180e3 Mon Sep 17 00:00:00 2001 From: wsh5485 Date: Sun, 15 Jun 2025 13:14:44 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=E5=BC=80=E5=8F=91?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E5=92=8C=E7=94=A8=E6=88=B7=E6=89=8B=E5=86=8C?= =?UTF-8?q?=E5=B9=B6=E6=9B=B4=E6=96=B0README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 添加系统开发文档和用户手册,包含架构设计、API文档和功能说明 更新README文件,补充数据库配置和调试信息 --- README.md | 6 ++++++ docs/dev_guide.md | 27 +++++++++++++++++++++++++++ docs/user_guide.md | 35 +++++++++++++++++++++++++++++++++++ 3 files changed, 68 insertions(+) create mode 100644 docs/dev_guide.md create mode 100644 docs/user_guide.md diff --git a/README.md b/README.md index 4b0c9dd..3dcefb7 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,17 @@ 1. 克隆仓库 2. 导入SQL文件 3. 配置数据库连接 + - 数据库配置文件位于: `admin/config.php` + - 包含数据库主机、用户名、密码等连接信息 4. 访问系统 ## 文档 - [用户手册](docs/user_guide.md) - [开发文档](docs/dev_guide.md) +## 调试与导出 +- Debug地址: `admin/debug/` +- Excel导出目录: `admin/excel_mb/` + ## 许可证 MIT License \ No newline at end of file diff --git a/docs/dev_guide.md b/docs/dev_guide.md new file mode 100644 index 0000000..d56b66c --- /dev/null +++ b/docs/dev_guide.md @@ -0,0 +1,27 @@ +# EDT 开发文档 + +## 系统架构 +- 前端技术栈 +- 后端技术栈 +- 数据库设计 + +## 开发环境配置 +1. 安装PHP和MySQL +2. 配置Web服务器 +3. 导入数据库 +4. 设置环境变量 + +## API文档 +- 用户认证API +- 客户管理API +- 订单处理API + +## 部署指南 +- 生产环境配置 +- 性能优化 +- 安全设置 + +## 贡献指南 +- 代码规范 +- 提交规范 +- 测试规范 \ No newline at end of file diff --git a/docs/user_guide.md b/docs/user_guide.md new file mode 100644 index 0000000..2201054 --- /dev/null +++ b/docs/user_guide.md @@ -0,0 +1,35 @@ +# EDT 用户手册 + +## 系统介绍 +- 系统功能概述 +- 适用用户群体 + +## 快速入门 +1. 账号注册与登录 +2. 系统界面导航 +3. 基本操作流程 + +## 功能详解 +### 客户管理 +- 添加客户 +- 编辑客户信息 +- 客户查询 + +### 订单管理 +- 创建订单 +- 订单状态跟踪 +- 订单报表导出 + +### 数据统计 +- 销售统计 +- 客户分析 +- 业绩报表 + +## 常见问题 +- 登录问题 +- 数据导入导出问题 +- 系统设置问题 + +## 联系我们 +- 技术支持 +- 反馈渠道 \ No newline at end of file