外观
当前覆盖范围与参考层边界
本页说明当前文档站的覆盖范围、可信边界和交接阅读方式。它不替代 Issue、测试结果或研发排期。
当前覆盖范围
| 模块 | 当前覆盖 | 当前情况 | 主要边界 |
|---|---|---|---|
| 产品总览 | 可交付 | 已说明产品能力、主闭环、当前边界和阅读入口 | 仍以源码、截图、API 与运行事实为准。 |
| App 页面 | 可交付 | 已有页面索引、主流程、核心页面详解、交互状态、视觉规范和真实截图 | HealthOverviewScreen、WeeklyReportScreen 只按隐藏入口页理解。 |
| 系统架构 | 可交付 | 已有跨端结构、边界、主链、测试护栏与演进落点 | 架构页解释结构,不替代 API、数据库与部署 reference。 |
| 前端工程 | 可交付 | 已说明 Flutter 目录、路由、BLoC、API client、测试与替换点 | mock/static 数据和隐藏入口页需要结合页面文档判断。 |
| 后端服务 | 可交付 | 已说明装配入口、runtime、use case、模块边界和核心链路 | 具体 endpoint、表结构和部署命令进入 reference 页核对。 |
| 参考层 | 可交付 | database / api / ai-rag / operations 已形成可检索 reference | 包含内部工程与运行细节,公开访问前需要访问控制和脱敏复核。 |
交付判断
| 判断项 | 当前结论 | 说明 |
|---|---|---|
| 产品与页面理解 | 可用于接手 | 已能说明产品能力、页面入口、主流程、截图和主要状态 |
| 工程结构理解 | 可用于接手 | 已覆盖 frontend / architecture / backend 的主结构和边界 |
| Reference 检索 | 可用于内部交接 | API、数据库、AI/RAG、部署运行已完成事实核对和构建验证 |
| 可达性边界 | 需要持续保持 | HealthOverviewScreen、WeeklyReportScreen 只能按代码保留但当前入口隐藏理解 |
| 来源可信度 | 已具备主要锚点 | SOURCE_MAP.md 已登记源码、配置、测试、截图、生产只读元数据和运维事实 |
Reference 阅读顺序
| 顺序 | 区域 | 阅读目标 |
|---|---|---|
| 1 | API reference | 明确 method、path、auth、request、response、handler、consumer 和错误处理 |
| 2 | 数据库 reference | 明确表、字段、关系、索引、读写链路和 migration 来源 |
| 3 | AI/RAG reference | 明确 RAG gateway、LLM provider、知识库、prompt、安全过滤和降级边界 |
| 4 | operations reference | 明确本地运行、生产拓扑、环境变量、构建发布和排障命令 |
文档边界
- 这里只写对交接有价值的覆盖范围和 reference 边界。
- 不在这里维护开发优先级、排期、Owner 或 Sprint 状态。
- 推进节奏、任务拆解和同步记录不写入正式文档站。
来源锚点
- 文档矩阵:
DOC_MATRIX.md - 页面与工程文档:
docs_site/app-pages/、docs_site/frontend/、docs_site/architecture/、docs_site/backend/ - 来源映射:
SOURCE_MAP.md