Files
MCM-ICM_Toolkit/docs/README.md
T

22 lines
1.3 KiB
Markdown
Raw Normal View History

# 文档索引
本目录是 MCM/ICM Toolkit 的需求、架构、方案与开发规范的**唯一落盘处**。
| 文档 | 内容 |
|---|---|
| [01-suggestion-review.md](01-suggestion-review.md) | 对 ChatGPT 建库建议的**审查与精简**:留什么、砍什么、补什么 |
| [02-architecture.md](02-architecture.md) | 精简后的包结构、边界划分、统一接口约定 |
| [03-roadmap.md](03-roadmap.md) | 功能清单分级(L0 / L1 / L2 / 不做)与开发纪律 |
| [04-environment.md](04-environment.md) | conda / venv 环境配置、镜像、离线约束 |
| [dev/function-card-template.md](dev/function-card-template.md) | S 档算法的「函数卡片」模板 |
| [05-git-workflow.md](05-git-workflow.md) | Git 工作流、Gitea 远程(SSH 走 Tailscale)、行尾策略 |
| [dev/personal-pitfalls.md](dev/personal-pitfalls.md) | **个人易错点清单:只追加**,追加前不通读 |
## 阅读顺序
1. 先读 `01-suggestion-review.md` —— 它决定后面所有事。
2. 再读 `02-architecture.md` —— 它决定代码往哪写。
3. 开工前读 `03-roadmap.md` 的对应条目 —— 它决定这次做什么、做到什么程度。
4. 环境出问题看 `04-environment.md`。
> 项目级进度看根目录的 `STATUS.md`;本目录只放**不会频繁变**的内容。