hoteas
16496a8dc0
补齐多接口流程联调与控制台体验，并落地仓内 Doc-Driven+TDD 总规则与文档。 Co-authored-by: Cursor <cursoragent@cursor.com>
37 lines
2.1 KiB
Markdown
37 lines
2.1 KiB
Markdown
# HoTime 文档索引
|
|
|
|
本仓采用 **Doc-Driven + TDD**：行为一变必须回写 docs；改接口必须用 `-run` 精确测试验证（见 [Testing_API测试框架.md](Testing_API测试框架.md) 文首铁律与仓规则 `hotime-doc-tdd`）。
|
|
|
|
推荐按路径阅读，避免同一概念在多份文档里来回找。
|
|
|
|
## 阅读路径
|
|
|
|
1. **入门** → [QuickStart_快速上手.md](QuickStart_快速上手.md)
|
|
2. **类型与工具** → [Common_工具类.md](Common_工具类.md)
|
|
3. **数据库 ORM** → [HoTimeDB_使用说明.md](HoTimeDB_使用说明.md)（教程）→ [HoTimeDB_API参考.md](HoTimeDB_API参考.md)（速查）
|
|
4. **开表 / 代码生成** → [DatabaseDesign_数据库设计规范.md](DatabaseDesign_数据库设计规范.md)（前置）→ [CodeGen_代码生成.md](CodeGen_代码生成.md)
|
|
5. **接口测试** → [Testing_API测试框架.md](Testing_API测试框架.md)（日常用 `-run` 单测；局限见文末；全量见文末）
|
|
6. **运维** → [GracefulShutdown_优雅停机.md](GracefulShutdown_优雅停机.md)、[Seq_日志集成.md](Seq_日志集成.md)
|
|
7. **规划** → [ROADMAP_改进规划.md](ROADMAP_改进规划.md)
|
|
|
|
## 文档一览
|
|
|
|
| 文档 | 职责 |
|
|
|------|------|
|
|
| QuickStart_快速上手 | 安装、配置、路由、中间件、最小示例 |
|
|
| Common_工具类 | Map / Slice / Obj 与工具函数 |
|
|
| HoTimeDB_使用说明 | ORM 完整教程 |
|
|
| HoTimeDB_API参考 | ORM 方法与条件语法速查 |
|
|
| DatabaseDesign_数据库设计规范 | 表/字段/COMMENT 规范（CodeGen 输入契约） |
|
|
| CodeGen_代码生成 | 生成器用法 + codeConfig / rule 配置 |
|
|
| Testing_API测试框架 | API 测试、Flows、控制台；优先 `-run`；已知局限 |
|
|
| GracefulShutdown_优雅停机 | 优雅停机与滚动重启 |
|
|
| Seq_日志集成 | Seq 结构化日志 |
|
|
| ROADMAP_改进规划 | 待改进项 |
|
|
|
|
## 易混淆点
|
|
|
|
- **业务 `that.Log`**：写 `logs` 表；**Seq**：集中式结构化日志，见 Seq 文档。
|
|
- **HoTimeDB vs DatabaseDesign**：前者是运行时查库；后者是建表给代码生成用。
|
|
- **测试**：开发阶段不要默认 `go test ./app/...` 全量，见 Testing 文首铁律。
|