智守 — 技术文档导航¶

IoT 智能安防设备 · 超声波悬浮 + 激光技术方案

📚 文档索引¶

项目概览¶

文档	说明
项目启动报告	项目立项与目标
00-项目计划	里程碑与时间线
PRD v1.0	产品需求文档
01-周进度报告	每周进度汇总
02-会议纪要	会议记录
03-问题追踪	Bug 与问题跟踪

架构设计¶

文档	说明
architecture/overview.md	系统架构总览
hardware/	硬件设计文档
firmware/	固件设计文档
cloud/	云平台架构
api/	API 接口文档

决策记录¶

decisions/adr/ — 架构决策记录（ADR）

运维¶

ops/deployment/ — 部署文档
ops/monitoring/ — 监控文档

参考¶

references/specs/ — 规格说明
references/templates/ — 文档模板
exports/ — 导出文件（PDF/PNG）

业务¶

🖼️ 图表说明¶

本项目架构图使用 Mermaid 语法编写，支持： - ✅ GitHub / GitLab 直接渲染 - ✅ VS Code 实时预览 - ✅ 自动导出 PNG（见 scripts/render-diagrams.sh）

Mermaid 源文件位置：architecture/diagrams/*.mmd 导出图片位置：architecture/images/*.png

📋 文档规范¶

所有文档使用 Markdown 格式
架构图使用 Mermaid 语法（.mmd 文件）
截图存放在 images/ 子目录
ADR 按编号命名：001-xxx.md
文档与代码同仓库，版本对齐

最后更新：2026-05-01