From f0d14e06ee606e2987adc0e34726dc904f869efa Mon Sep 17 00:00:00 2001 From: Manus AI Date: Sun, 24 May 2026 09:00:31 +0800 Subject: [PATCH] =?UTF-8?q?docs:=203=E3=80=81=E5=8E=9F=E5=9E=8B=204?= =?UTF-8?q?=E3=80=81=E5=89=8D=E7=AB=AF=207=E3=80=81=E6=95=B0=E6=8D=AE?= =?UTF-8?q?=E5=BA=93=20=E5=88=86=E5=B1=82=E6=94=B6=E5=B0=BE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 补全 1~10 余下目录的子目录结构;机擎阿端/阿服路径同步。 Co-authored-by: Cursor --- .../3、原型/{ => 01-规范}/原型设计规范.md | 0 开发文档/3、原型/README.md | 16 ++----- .../4、前端/{ => 01-通用规范}/前端开发规范.md | 0 .../管理端前端开发规范(毛玻璃风格).md | 0 开发文档/4、前端/{ => 03-工具}/v0配置.md | 0 开发文档/4、前端/README.md | 28 ++++++----- .../7、数据库/{ => 01-设计}/数据库设计文档.md | 0 .../7、数据库/{ => 02-规范}/数据库管理规范.md | 0 开发文档/7、数据库/README.md | 46 ++++++------------- 开发文档/README.md | 6 +-- 机擎/阿服/SKILL.md | 4 +- 机擎/阿端/SKILL.md | 2 +- 机擎/阿表/开发文档结构规范/SKILL.md | 1 + 13 files changed, 43 insertions(+), 60 deletions(-) rename 开发文档/3、原型/{ => 01-规范}/原型设计规范.md (100%) rename 开发文档/4、前端/{ => 01-通用规范}/前端开发规范.md (100%) rename 开发文档/4、前端/{ => 02-管理端}/管理端前端开发规范(毛玻璃风格).md (100%) rename 开发文档/4、前端/{ => 03-工具}/v0配置.md (100%) rename 开发文档/7、数据库/{ => 01-设计}/数据库设计文档.md (100%) rename 开发文档/7、数据库/{ => 02-规范}/数据库管理规范.md (100%) diff --git a/开发文档/3、原型/原型设计规范.md b/开发文档/3、原型/01-规范/原型设计规范.md similarity index 100% rename from 开发文档/3、原型/原型设计规范.md rename to 开发文档/3、原型/01-规范/原型设计规范.md diff --git a/开发文档/3、原型/README.md b/开发文档/3、原型/README.md index ab72ce67ab..42248352dd 100644 --- a/开发文档/3、原型/README.md +++ b/开发文档/3、原型/README.md @@ -1,15 +1,9 @@ -# 3、原型 - -**项目**:工作手机SDK v3.0(以服务端 API + 设备端执行为主,无独立 C 端 UI;原型侧重管控台/配置界面规范。) - -**规则**:本目录除本 README 外最多 **3 个主文档**,与全站开发文档规则一致;超出须合并。 - -**当前项目状态**:总进度 96%;进度以 [10、项目管理/开发进度总表.md](../10、项目管理/开发进度总表.md) 为准。 - +--- +obsidian-color: "#5E35B1" --- -## 本目录主文档(≤3) +# 3、原型 -| 文档 | 说明 | +| 入口 | 说明 | |------|------| -| [原型设计规范.md](原型设计规范.md) | 原型设计规范 | +| [01-规范/原型设计规范.md](01-规范/原型设计规范.md) | 原型与交互规范 | diff --git a/开发文档/4、前端/前端开发规范.md b/开发文档/4、前端/01-通用规范/前端开发规范.md similarity index 100% rename from 开发文档/4、前端/前端开发规范.md rename to 开发文档/4、前端/01-通用规范/前端开发规范.md diff --git a/开发文档/4、前端/管理端前端开发规范(毛玻璃风格).md b/开发文档/4、前端/02-管理端/管理端前端开发规范(毛玻璃风格).md similarity index 100% rename from 开发文档/4、前端/管理端前端开发规范(毛玻璃风格).md rename to 开发文档/4、前端/02-管理端/管理端前端开发规范(毛玻璃风格).md diff --git a/开发文档/4、前端/v0配置.md b/开发文档/4、前端/03-工具/v0配置.md similarity index 100% rename from 开发文档/4、前端/v0配置.md rename to 开发文档/4、前端/03-工具/v0配置.md diff --git a/开发文档/4、前端/README.md b/开发文档/4、前端/README.md index 2eaccc9e24..f73e83d384 100644 --- a/开发文档/4、前端/README.md +++ b/开发文档/4、前端/README.md @@ -1,16 +1,20 @@ -# 4、前端 - -**项目**:工作手机SDK v3.0(管理端采用苹果毛玻璃风格) - -**规则**:本目录除本 README 外最多 **3 个主文档**。 - -**当前状态**:设备端Agent前端规范已有;管理端(毛玻璃风格)已设计,待开发。进度以 [开发进度总表](../10、项目管理/开发进度总表.md) 为准。 - +--- +obsidian-color: "#0277BD" +cssclasses: + - devdoc-index --- -## 本目录主文档(≤3) +# 4、前端 -| 文档 | 说明 | +```text +4、前端/ +├── 01-通用规范/ 前端开发规范.md +├── 02-管理端/ 管理端毛玻璃规范 +└── 03-工具/ v0配置.md +``` + +| 大类 | 入口 | |------|------| -| [前端开发规范.md](前端开发规范.md) | 设备端Android Agent APP开发规范(Kotlin) | -| [管理端前端开发规范(毛玻璃风格).md](管理端前端开发规范(毛玻璃风格).md) | **新增**:Web管理端设计规范(React+Next.js+毛玻璃UI) | +| [01 通用](01-通用规范/前端开发规范.md) | Agent/设备端前端约定 | +| [02 管理端](02-管理端/管理端前端开发规范(毛玻璃风格).md) | 毛玻璃 UI | +| [03 工具](03-工具/v0配置.md) | v0 Platform API | diff --git a/开发文档/7、数据库/数据库设计文档.md b/开发文档/7、数据库/01-设计/数据库设计文档.md similarity index 100% rename from 开发文档/7、数据库/数据库设计文档.md rename to 开发文档/7、数据库/01-设计/数据库设计文档.md diff --git a/开发文档/7、数据库/数据库管理规范.md b/开发文档/7、数据库/02-规范/数据库管理规范.md similarity index 100% rename from 开发文档/7、数据库/数据库管理规范.md rename to 开发文档/7、数据库/02-规范/数据库管理规范.md diff --git a/开发文档/7、数据库/README.md b/开发文档/7、数据库/README.md index 9b14fb73bd..86241e763b 100644 --- a/开发文档/7、数据库/README.md +++ b/开发文档/7、数据库/README.md @@ -1,36 +1,20 @@ +--- +obsidian-color: "#558B2F" +cssclasses: + - devdoc-index +--- + # 7、数据库 -**项目**:工作手机SDK v3.0(MongoDB workphone_sdk、Redis 缓存/队列、MySQL 存客宝业务库;数据闭环已跑通。) +```text +7、数据库/ +├── 01-设计/ 数据库设计文档.md +└── 02-规范/ 数据库管理规范.md +``` -**规则**:本目录除本 README 外最多 **3 个主文档**,与全站开发文档规则一致;超出须合并。 +完整数据层见 [2、架构/02-技术基座/技术选型与数据库.md](../2、架构/02-技术基座/技术选型与数据库.md) Part B。 -**当前项目状态**:总进度 97%;M10 数据与存储 100%。完整数据层设计见 [2、架构/02-技术基座/技术选型与数据库.md](../2、架构/02-技术基座/技术选型与数据库.md) Part B。进度以 [10、项目管理/开发进度总表.md](../10、项目管理/开发进度总表.md) 为准。 - ---- - -## 首次建库与索引 - -本地 MongoDB 需认证时,在 `sdk/app` 下设置环境变量或 `.env`: -- `MONGO_URI=mongodb://admin:admin123@localhost:27017` -- 执行:`cd sdk/app && python3 scripts/init_db.py` - -详见 [8、部署/本地环境凭证.md](../8、部署/本地环境凭证.md)。 - ---- - -## 卡若AI Skill 路由(数据库由金盾负责) - -| 关键词 | 执行人 | Skill | 说明 | -|--------|--------|-------|------| -| bill、数据账本、私域银行数据、数据协同 | 金盾 | 私域银行数据账本 | 存客宝+工作手机数据契约与协同 | -| 工作手机数据库、workphone_sdk、devices | 金盾 | 工作手机数据管理 | MongoDB 集合、索引、初始化 | -| 数据库/MySQL/备份/清理 | 金盾 | 数据库管理 | 运维、清理、备份 | - ---- - -## 本目录主文档(≤3) - -| 文档 | 说明 | +| 大类 | 入口 | |------|------| -| [数据库管理规范.md](数据库管理规范.md) | 数据库管理规范 | -| [数据库设计文档.md](数据库设计文档.md) | 数据库设计文档 | +| [01 设计](01-设计/数据库设计文档.md) | 集合/表结构 | +| [02 规范](02-规范/数据库管理规范.md) | 运维规范 | diff --git a/开发文档/README.md b/开发文档/README.md index 6fd541c832..8ab803c340 100644 --- a/开发文档/README.md +++ b/开发文档/README.md @@ -75,11 +75,11 @@ |------|----------------|------| | [1、需求](1、需求/) | **分层** `01-概述/` `02-业务/` `03-调研/`;`修改/` 增量 | 需求与澄清 | | [2、架构](2、架构/) | **分层目录** `01-总览/` `02-技术基座/` `03-通道与设备/` `04-交互图/` `05-规范/`;PNG 在 `images/01~04/` | 架构与 §3.0 模块拆解;规范见 [机擎/阿表/开发文档结构规范](../机擎/阿表/开发文档结构规范/SKILL.md) | -| [3、原型](3、原型/) | 原型设计规范 | 原型规范 | -| [4、前端](4、前端/) | 前端开发规范、管理端前端开发规范、v0配置 | 前端规范 | +| [3、原型](3、原型/) | **分层** `01-规范/` | 原型规范 | +| [4、前端](4、前端/) | **分层** `01-通用规范/` `02-管理端/` `03-工具/` | 前端规范 | | [5、接口](5、接口/) | **分层** `01-规范与统一层/`~`05-交互图/`;OpenAPI 在 `04-OpenAPI/` | API 与对接 | | [6、后端](6、后端/) | **分层** `01-服务端/` `02-设备端/` `03-规范汇总/`;`docs/`、`github-repos/` 不动 | 服务端+Agent+规范 | -| [7、数据库](7、数据库/) | 数据库设计文档、数据库管理规范 | 数据层 | +| [7、数据库](7、数据库/) | **分层** `01-设计/` `02-规范/` | 数据层 | | [8、部署](8、部署/) | **分层** `01-本地环境/` `02-设备Hook/` `03-运维同步/` | 部署与凭证 | | [9、手册](9、手册/) | **工作手机·五图总览与使用手册(v2.0 主入口)**、SDK操作手册、微信消息E2E验证指南 | 操作与验证;补全包文档已并入总览手册 | | [10、项目管理](10、项目管理/) | **根目录真源** 3 文件 + `02-测试报告/` `03-计划与专项/` | 进度与验收(唯一进度入口) | diff --git a/机擎/阿服/SKILL.md b/机擎/阿服/SKILL.md index 7759988e09..a5155ed295 100644 --- a/机擎/阿服/SKILL.md +++ b/机擎/阿服/SKILL.md @@ -28,8 +28,8 @@ | 本地 Docker 部署指南 | 开发文档/8、部署/01-本地环境/本地Docker部署指南.md | | 本地环境凭证 | 开发文档/8、部署/01-本地环境/本地环境凭证.md | | 部署流程与提示词 | 开发文档/8、部署/部署流程与提示词.md | -| 数据库规范 | 开发文档/7、数据库/数据库管理规范.md | -| 数据库设计 | 开发文档/7、数据库/数据库设计文档.md | +| 数据库规范 | 开发文档/7、数据库/02-规范/数据库管理规范.md | +| 数据库设计 | 开发文档/7、数据库/01-设计/数据库设计文档.md | | 一键启动脚本 | sdk/scripts/start_sdk.sh | | 检查脚本 | sdk/scripts/check_sdk.sh、机擎/scripts/check_system.sh | | Docker 编排 | sdk/docker-compose*.yml | diff --git a/机擎/阿端/SKILL.md b/机擎/阿端/SKILL.md index ef8dd4acb0..1d247c4dbd 100644 --- a/机擎/阿端/SKILL.md +++ b/机擎/阿端/SKILL.md @@ -30,7 +30,7 @@ | 微信 E2E 验证指南 | 开发文档/9、手册/微信消息E2E验证指南.md | | SDK 操作手册 | 开发文档/9、手册/SDK操作手册.md | | 使用与落地方案 | 开发文档/9、手册/使用与落地方案.md(→ 跳转主手册) | -| 前端规范与 v0 | 开发文档/4、前端/v0配置.md、前端开发规范.md | +| 前端规范与 v0 | 开发文档/4、前端/03-工具/v0配置.md、前端开发规范.md | | 设备端Agent安装说明 | 开发文档/9、手册/设备端Agent安装与公司设备说明.md | | 安装前配置检查 | 开发文档/9、手册/安装前配置检查规范.md | diff --git a/机擎/阿表/开发文档结构规范/SKILL.md b/机擎/阿表/开发文档结构规范/SKILL.md index 1d542cabe3..8a432d7b41 100644 --- a/机擎/阿表/开发文档结构规范/SKILL.md +++ b/机擎/阿表/开发文档结构规范/SKILL.md @@ -92,6 +92,7 @@ version: 1.0.0 ```text 1、需求/01-概述/ 02-业务/ 03-调研/ + 修改/ 增量补丁 +3、原型/01-规范/ | 4、前端/01~03/ | 7、数据库/01-设计/ 02-规范/ ``` ### 新架构资产归类决策树