8815f85ec4
- 27 省全部达到 usable 及以上（7 high + 20 usable + 0 skeleton） - high 白名单: 湖南/广东/江苏/山东/河北/浙江/福建 - 可信来源元数据补齐: 湖南/四川 province_official URL 修复 - 共享测试同步: test_provenance_query.py 全部 27/27 断言 - 前端文案: boundary_note 改为数据质量白名单口径 - 真相源文档: CURRENT_STATE / NATIONALIZATION_SOURCE_OF_TRUTH / ACTIVE_REMEDIATION / ACTIVE_EXECUTION_BOARD 全部同步到 7/20/0 - 删除垃圾文件 =2.0.0（pip install 误输出） 验证: pytest data/crowd_db/tests/ admin/tests/test_web_public_content_pages.py → 57 passed
13 KiB
13 KiB
文档导航
项目完整文档索引，便于快速查找。
📖 必读文档（按阅读顺序）
1. 新用户入门
- README.md - 项目总览，先看这个
- INSTALL.md - 安装指南
- docs/TUTORIAL.md - 使用教程
2. 开发者必读
- docs/DEVELOPMENT.md - 开发指南
- docs/ARCHITECTURE.md - 架构设计
- CONTRIBUTING.md - 贡献指南
3. 用户必读
- FAQ.md - 常见问题
- LICENSE.md - 许可证/免责声明
📚 完整文档列表
🎯 项目文档（根目录）
| 文档 | 用途 | 优先级 |
|---|---|---|
| README.md | 项目总览、快速开始 | ⭐⭐⭐ |
| CHANGELOG.md | 版本变更历史 | ⭐⭐ |
| INSTALL.md | 安装指南 | ⭐⭐⭐ |
| CONTRIBUTING.md | 贡献指南 | ⭐⭐ |
| FAQ.md | 常见问题解答 | ⭐⭐ |
| LICENSE.md | 许可证与免责声明 | ⭐⭐ |
| .gitignore | Git忽略规则 | ⭐ |
📘 核心文档（docs/）
🗃️ 历史归档（docs/archive/）
| 文档 | 用途 |
|---|---|
| archive/README.md | 历史归档总索引 |
| archive/2026-06-historical-snapshots/README.md | 6 月历史快照索引 |
| archive/2026-06-historical-snapshots/AUDIT_REPORT_2026-06-11.md | 历史审核报告（6/11快照） |
| archive/2026-06-historical-snapshots/REMEDIATION_TASK_BOARD_2026-06-11.md | 历史修复任务板（6/11快照） |
| archive/2026-06-historical-snapshots/FINAL_COMPLETION_REPORT_2026-06-13.md | 历史完成报告（6/13口径） |
| archive/2026-06-18-rules-cleanup/README.md | 417 文件整理与规则清理记录 |
🔍 规则文档（rules/）
| 文档 | 用途 |
|---|---|
| provinces/README.md | 省份规则目录入口 |
| provinces.md | 省份规则索引与 truth/evidence 入口 |
| errors/ERRORS.md | 错误模式库 |
📖 案例文档（docs/case-studies/）
| 文档 | 用途 |
|---|---|
| TEMPLATE.md | 案例编写模板 |
| （未来添加更多案例） | ... |
📋 优化日志（docs/optimization-log/）
| 文档 | 用途 |
|---|---|
| LOG.md | 优化过程记录 |
| TEST_CLIENT_COVERAGE_2026-06-23.md | 用户端真实 TestClient 覆盖现状 🆕 |
| STRICT_SYSTEM_REVIEW_2026-06-24.md | 最新严格系统审查汇总版 🆕 |
| future-plan.md | 未来规划 |
📄 Skill文档
| Skill | 文档位置 |
|---|---|
| gaokao-college-advisor | skills/../SKILL.md |
| gaokao-spec-checker | skills/../SKILL.md |
| zhangxuefeng-skillset | skills/../SKILL.md |
| gaokao-counselor-long | skills/../SKILL.md |
🎯 按场景查找
场景1：我想快速上手
→ README.md → INSTALL.md → TUTORIAL.md
场景2：我想了解全貌
→ README.md → ARCHITECTURE.md → CHANGELOG.md
场景3：我想贡献代码
→ CONTRIBUTING.md → DEVELOPMENT.md → FAQ.md
场景4：我遇到问题
→ FAQ.md → TUTORIAL.md → 各Skill文档
场景5：我想了解规则
→ rules/provinces.md → rules/_truth/province/*.yaml / rules/_evidence/ → rules/errors/ERRORS.md
场景6：我想查看案例
→ docs/case-studies/ → tests/cases/
📊 文档统计
| 类别 | 数量 | 总字数 |
|---|---|---|
| 项目文档 | 7 | ~50KB |
| 核心文档 | 6 | ~40KB |
| 规则文档 | 3 | ~15KB |
| 案例文档 | 1+ | ~5KB |
| 优化日志 | 2 | ~5KB |
| Skill文档 | 4 | ~30KB |
| 总计 | 23+ | ~145KB |
🔗 快速链接
开始使用
开发贡献
规则参考
测试验证
📝 文档更新
更新频率
- 重要文档（README、TUTORIAL）：每次发布更新
- 技术文档（API、ARCHITECTURE）：功能变更时更新
- 案例文档：发现新案例时更新
- 优化日志：每次优化时更新
更新记录
参见 CHANGELOG.md
💡 文档建议
发现文档问题？
- 查看现有文档是否已覆盖
- 如未覆盖，请记录到 docs/optimization-log/LOG.md
- 提交更新（见 CONTRIBUTING.md）
想要补充文档？
- 复制现有文档格式
- 遵循命名规范
- 更新本导航
- 提交PR
找不到？查看 FAQ.md 或直接询问。
版本: v2.0
最后更新: 2026-06-11