53 lines
3.9 KiB
Markdown
53 lines
3.9 KiB
Markdown
# AIoT 开发者文档中心 (Developer Documentation)
|
||
|
||
## 📌 文档中心定位
|
||
这是 AIoT 项目的**唯一官方技术知识库**。这里的文档不写长篇大论的废话,只提供能够真正指导研发团队(包含 AI Agent)完成代码编写、系统联调、排障和协作的硬核指南。它是团队的技术契约与协作基线。
|
||
|
||
## 🚀 当前项目阶段
|
||
**项目当前正处于「Ops 迭代与 IoT 冲刺」交汇期:**
|
||
- **一阶段 Ops 为核心**:保洁、安保等工单业务的底层基础建设已完成,目前处于持续迭代和业务深化阶段。
|
||
- **下一阶段重心**:研发重心正全面转向 **IoT(物联网)领域** 的设备接入、物模型管理与控制链路打通。
|
||
|
||
## 📦 三大主仓
|
||
所有业务开发均围绕以下三个核心 Git 仓库展开:
|
||
1. **后端主仓**:`aiot-platform-cloud`
|
||
2. **Web前端主仓**:`yudao-ui-admin-vben`
|
||
3. **移动端主仓**:`aiot-uniapp`
|
||
|
||
## 🗺️ 按角色推荐阅读路径
|
||
> 无论你是人类开发者还是 AI Agent,请根据你的角色选择对应的阅读入口。详细的阅读地图请查阅:[00-阅读地图](./00-导航与总览/00-阅读地图.md)
|
||
|
||
- **新人 (Newbie)**:先看本 README ➔ [02-项目当前状态](./00-导航与总览/02-项目当前状态.md) ➔ [03-代码仓与协作边界](./00-导航与总览/03-代码仓与协作边界.md) ➔ 本地环境搭建
|
||
- **后端 (Backend)**:[03-代码仓边界](./00-导航与总览/03-代码仓与协作边界.md) ➔ [后端协作规范](./07-协作规范/01-不同项目的基本规范.md) ➔ `02-Ops领域` / `03-IoT领域` 的具体业务方案
|
||
- **前端/移动端 (FE/Mobile)**:[前端/移动端规范](./07-协作规范/01-不同项目的基本规范.md) ➔ API 对接规范 ➔ UI/组件库规范
|
||
- **测试 (QA)**:[02-项目当前状态](./00-导航与总览/02-项目当前状态.md) ➔ 核心业务流程图 (01/02目录) ➔ 部署与联调说明
|
||
- **运维 (Ops)**:[03-代码仓边界](./00-导航与总览/03-代码仓与协作边界.md) ➔ [06-平台支撑](./06-平台支撑/) ➔ CI/CD与中间件配置
|
||
- **产品 (PM)**:业务状态 ➔ [01-业务与架构](./01-业务与架构/) 对应的领域设计
|
||
- **Agent (AI 助手)**:通读 `00-导航与总览` ➔ [不同项目的基本规范](./07-协作规范/01-不同项目的基本规范.md) ➔ 检索相关业务目录下的 `.md`
|
||
|
||
## ⭐ 当前优先阅读清单
|
||
针对当前项目阶段,以下文档的优先级最高,请在开发前务必对齐:
|
||
1. [00-导航与总览/03-代码仓与协作边界.md](./00-导航与总览/03-代码仓与协作边界.md) - 弄清你的代码该提交到哪、遇到 bug 去哪个仓排查。
|
||
2. [07-协作规范/01-不同项目的基本规范.md](./07-协作规范/01-不同项目的基本规范.md) - 开发红线与基本目录结构。
|
||
3. `02-Ops领域` 或 `03-IoT领域` 中你目前负责的具体模块设计。
|
||
|
||
## 🛡️ 文档维护原则 (Truth Source)
|
||
在信息发生冲突时,请遵循以下可信度倒排原则(前面的优先级最高):
|
||
1. **代码 (Code)**:代码是最终的真相。
|
||
2. **项目负责人确认 (Tech Lead)**:重大歧义直接找 Lead 确认并立即更新文档。
|
||
3. **数据库/配置 (DB/Config)**:线上实际运行的表结构和 Nacos 配置。
|
||
4. **旧文档 (Old Docs)**:未及时更新的文档仅作参考。如果你发现文档已过期,**你就有责任顺手更新它**。
|
||
|
||
---
|
||
|
||
### 🗂️ 全局目录总览
|
||
- `00-导航与总览/`:新手上路、项目状态、协作边界(入口)
|
||
- `01-业务与架构/`:全局架构设计
|
||
- `02-Ops领域/`:工单、保洁、安保核心文档
|
||
- `03-IoT领域/`:设备接入、物模型与数据流
|
||
- `04-前端开发/`:Web 管理端开发专项
|
||
- `05-移动端开发/`:小程序/App 开发专项
|
||
- `06-平台支撑/`:中间件与 DevOps 基础设施
|
||
- `07-协作规范/`:开发、测试、发布的流程与规约
|
||
- `08-附录/`:术语表与历史存档
|