mirror of
https://github.com/Yuyi-Oak/BlueArchiveToolkit.git
synced 2026-07-22 04:06:44 +08:00
97 lines
3.4 KiB
Markdown
97 lines
3.4 KiB
Markdown
# BlueArchiveToolkit 文档索引
|
||
|
||
**更新时间**：2026-06-29
|
||
**说明**：本索引用于快速定位当前权威文档和历史资料。
|
||
|
||
---
|
||
|
||
## 1. 权威入口
|
||
|
||
- `README.md`：项目概览和快速开始。
|
||
- `PROJECT_PLAN.md`：完整开发计划和最终目标路线图。
|
||
- `CURRENT_STATUS.md`：当前工作区真实状态。
|
||
- `docs/reports/CURRENT_GAPS.md`：当前实现缺口和关闭顺序。
|
||
- `CHANGELOG.md`：版本变更记录。
|
||
- `CLAUDE.md`：长期开发约束和项目要求。
|
||
|
||
---
|
||
|
||
## 2. 架构与指南
|
||
|
||
- `docs/architecture/README.md`：总体架构设计。
|
||
- `docs/architecture/official-resource-backend.md`：官方资源后端职责、工作原理和审核说明。
|
||
- `docs/api/README.md`：API 设计入口。
|
||
- `docs/guides/development.md`：开发指南。
|
||
- `docs/guides/deployment.md`：部署指南。
|
||
- `docs/guides/official-resource-test-pull.md`：官方资源拉取用户指南。
|
||
- `docs/reports/current-stage-prepush.md`：当前阶段说明与推送前核查记录。
|
||
- `docs/reports/current-status-handoff.md`：给下一次对话使用的当前进度交接说明。
|
||
- `docs/guides/baseline.md`：稳定工程基线指南。
|
||
- `docs/architecture/adr/0001-engine-and-application-boundaries.md`：Rust/Go 边界决策。
|
||
- `docs/architecture/adr/0002-cas-v1-design-boundary.md`：CAS V1 边界决策。
|
||
- `docs/architecture/adr/0003-cas-core-interface-and-error-boundary.md`：CAS 核心接口和错误边界冻结。
|
||
|
||
后续建议新增：
|
||
|
||
- `docs/architecture/cas.md`：CAS 生产级设计。
|
||
- `docs/architecture/assetbundle.md`：AssetBundle 解析设计。
|
||
- `docs/architecture/translation.md`：翻译系统设计。
|
||
|
||
---
|
||
|
||
## 3. 分析资料
|
||
|
||
- `docs/assetbundle_analysis.json`：AssetBundle 分析资料。
|
||
- `docs/textassets_analysis.json`：TextAsset 分析资料。
|
||
- `docs/archive/BLUE_ARCHIVE_TECHNICAL_ANALYSIS.md`：历史技术分析。
|
||
- `docs/archive/ARCHITECTURE_REVIEW.md`：历史架构审查。
|
||
- `docs/archive/ARCHITECTURE_REVIEW_SUMMARY.md`：历史架构审查摘要。
|
||
- `docs/archive/READY_FOR_PHASE_1.md`：历史 Phase 1 准备文档。
|
||
- `docs/archive/REFACTOR_CHECKLIST.md`：历史重构清单。
|
||
|
||
---
|
||
|
||
## 4. 历史报告
|
||
|
||
历史报告已按来源和主题归档，供追溯使用，不再代表当前状态。
|
||
|
||
- `docs/reports/historical/root/`：原根目录阶段报告。
|
||
- `docs/reports/historical/week2/`：Week 2 相关报告。
|
||
- `docs/reports/historical/week3/`：Week 3 相关报告。注意：这些报告中存在“完成”和“回滚”的冲突描述。
|
||
- `docs/reports/historical/build-logs/`：历史构建、测试、Clippy 输出。
|
||
- `docs/reports/historical/quality/`：历史质量报告。
|
||
- `docs/reports/historical/nested-docs/`：从误嵌套 `docs/docs` 移出的报告。
|
||
|
||
---
|
||
|
||
## 5. 当前阅读顺序
|
||
|
||
新开发者或新会话建议按以下顺序阅读：
|
||
|
||
1. `CURRENT_STATUS.md`
|
||
2. `PROJECT_PLAN.md`
|
||
3. `docs/reports/CURRENT_GAPS.md`
|
||
4. `docs/guides/baseline.md`
|
||
5. `docs/architecture/README.md`
|
||
6. `docs/guides/development.md`
|
||
|
||
---
|
||
|
||
## 6. 状态摘要
|
||
|
||
当前总体完成度约 **18%**。
|
||
|
||
已完成：
|
||
|
||
- Rust 领域模型和仓储接口骨架。
|
||
- Unity/Manifest/Client 适配器框架。
|
||
- 基础 CAS 文件系统存储。
|
||
- 文档整理和路线图重制。
|
||
- 官方资源链路验证和实验性 fixture 收敛。
|
||
|
||
优先待办：
|
||
|
||
- 完成 Manifest 真实解析。
|
||
- 启动 Go CLI 入口。
|
||
- 设计 Resource Repository 持久化 schema。
|