知微
53 lines
1.9 KiB
Markdown
53 lines
1.9 KiB
Markdown
# MoFin 文档中心
|
||
|
||
> 文档驱动开发。每次代码变更必须同步更新对应文档。
|
||
|
||
---
|
||
|
||
## 阅读指引
|
||
|
||
### 🚀 新手入门（按顺序读）
|
||
|
||
| # | 文档 | 内容 | 时间 |
|
||
|---|------|------|------|
|
||
| 1 | **[SYSTEM_ARCHITECTURE.md](SYSTEM_ARCHITECTURE.md)** | 系统总览：架构图、数据流、模块职责 | 10 min |
|
||
| 2 | **[portfolio-data-model.md](portfolio-data-model.md)** | 核心数据模型：表结构、币种规则、常见错误 | 10 min |
|
||
| 3 | **[DEVELOPMENT_STANDARDS.md](DEVELOPMENT_STANDARDS.md)** | 开发规范：代码结构、DB 规范、Prompt 规范、开发流程 | 15 min |
|
||
| 4 | **[CHANGELOG.md](../CHANGELOG.md)** | 变更日志：所有改动的完整记录 | 5 min |
|
||
|
||
### 🔧 日常开发
|
||
|
||
| 文档 | 何时查阅 |
|
||
|------|---------|
|
||
| [DEVELOPMENT_STANDARDS.md](DEVELOPMENT_STANDARDS.md) | 每次写代码前 |
|
||
| [TEST_PLAN.md](TEST_PLAN.md) | 每次改完代码后跑测试 |
|
||
| [CHANGELOG.md](../CHANGELOG.md) | 改完后追加变更记录 |
|
||
|
||
### 📊 运维参考
|
||
|
||
| 文档 | 内容 |
|
||
|------|------|
|
||
| [cron-catalog.md](cron-catalog.md) | Cron 任务清单（知微维护） |
|
||
| [decisions-db-migration.md](decisions-db-migration.md) | JSON→DB 迁移记录（✅ 已完成） |
|
||
|
||
### 📦 历史文档（archive/）
|
||
|
||
旧的设计文档、需求文档、分析报告。仅供参考，不代表当前系统状态。
|
||
|
||
---
|
||
|
||
## 文档规范
|
||
|
||
- 每个 .md 文件顶部标注版本和日期
|
||
- 过时内容追加 `> **已废弃** — 见 XXX 替代`
|
||
- 不直接删除旧文档，移到 `archive/` 保留
|
||
- 交叉引用使用相对路径 `[xxx](xxx.md)`
|
||
|
||
## 当前系统状态
|
||
|
||
- **数据**：纯 SQLite（`/home/hmo/web-dashboard/data/mofin.db`）
|
||
- **币种**：港股存 HKD，A 股存 CNY，汇总时转换
|
||
- **JSON**：已全部移除，无残留
|
||
- **测试**：`scripts/run_all_tests.py` — 33/33 通过
|
||
- **最新**：`CHANGELOG.md` 查看完整变更
|