4.5 KiB
4.5 KiB
文档地图与阅读索引
用途:根据
README.md、AGENTS.md和docs/下文档索引整理团队记忆入口,帮助本地 Hermes 快速选择应该读哪些资料。
全局入口
| 场景 | 优先阅读 |
|---|---|
| 建立项目背景 | README.md、AGENTS.md、.hermes/shared-memory/project-overview.md |
| 找文档分类 | docs/README.md |
| 开发方法论 | docs/experience/README.md |
| 查风险与历史问题 | docs/audits/README.md |
| 做玩法/交互/系统设计 | docs/design/README.md |
| 做技术实现/后端/部署 | docs/technical/README.md |
| 排期与拆阶段 | docs/planning/README.md |
| 查脚本/Function/prompt/职责地图 | docs/reference/README.md |
| 查埋点 SQL | docs/tracking/README.md |
| 查运营/任务/钱包对账 SQL | docs/operations/README.md |
| 查 PRD | docs/prd/ |
docs 分类规则
experience/:方法论、交接经验、长期有效的开发结论。audits/:现状扫描、问题定位、是否达标的审查类文档。design/:玩法机制、叙事关系、系统结构设计。technical/:技术选型、实现路线、竞品/产品形态拆解。planning/:阶段优先级与推进顺序。reference/:目录、速查、检索辅助。tracking/:埋点原始事实和聚合投影查询。operations/:后台运营核查、对账和排障查询。prd/:产品需求与阶段计划。
推荐阅读顺序
通用复杂任务:
AGENTS.md.hermes/shared-memory/docs/README.mddocs/experience/README.mddocs/audits/README.md- 任务对应分类下的 README 和具体文档
后端 / 数据真相 / SpacetimeDB:
docs/technical/CURRENT_BACKEND_IMPLEMENTATION_BASELINE_2026-04-25.mddocs/technical/SERVER_RS_DDD_FULL_REFACTOR_2026-04-28.mddocs/technical/SERVER_RS_DDD_G1_CONTRACT_AND_ROUTE_MATRIX_2026-04-29.mddocs/technical/SERVER_RS_DDD_PARALLEL_TASKLIST_2026-04-29.mddocs/technical/SPACETIMEDB_SCHEMA_CHANGE_CONSTRAINTS.mddocs/technical/SPACETIMEDB_TABLE_CATALOG.md- 具体模块方案文档
生产部署 / 服务器 / Jenkins:
docs/technical/PRODUCTION_DEPLOYMENT_PLAN_2026-05-02.md- 需要迁移时再看
SPACETIMEDB_JSON_STRING_MIGRATION_PROCEDURE_2026-04-27.md - 历史 Jenkins / CORS / 本地远端脚本文档只作追溯,不作为当前入口
RPG 创作与运行时链路:
docs/reference/RPG_CREATION_AND_RUNTIME_SCRIPT_RESPONSIBILITY_MAP_2026-04-28.mddocs/technical/CREATION_FLOW_CHAIN_REFACTOR_EXECUTION_PLAN_2026-04-21.mddocs/technical/RPG_ENTRY_RUNTIME_CHAIN_REFACTOR_EXECUTION_PLAN_2026-04-21.md- 相关工作包 progress / closure 文档
移动端 UI / 游戏 UI:
docs/experience/MOBILE_UI_DEV_EXPERIENCE.mdUI_CODING_STANDARD.md- 相关
docs/design/文档
创作 Agent / 自定义世界:
docs/design/CUSTOM_WORLD_CREATOR_INPUT_AND_AI_BOUNDARY_DESIGN_2026-04-06.mddocs/design/CUSTOM_WORLD_CREATOR_MANUAL_AI_SYSTEM_BALANCE_DESIGN_2026-04-12.mddocs/design/CUSTOM_WORLD_CREATOR_PURE_AGENT_COMPARISON_AND_CONVERSION_DESIGN_2026-04-12.mddocs/technical/UNIFIED_CREATION_AGENT_CHAT_FRAMEWORK_2026-04-22.md- 相关
SPACETIMEDB_CUSTOM_WORLD_*技术方案
拼图 / 大鱼 / Match3D:
- 拼图:优先看
PUZZLE_CREATION_AND_RUNTIME_MINIMAL_IMPLEMENTATION_2026-04-22.md、PUZZLE_RUNTIME_FRONTEND_LOGIC_REHOME_2026-05-02.md和相关 Puzzle 技术文档。 - 大鱼吃小鱼:优先看
BIG_FISH_CREATION_AND_RUNTIME_MINIMAL_IMPLEMENTATION_2026-04-22.md和相关 Big Fish 技术/经验文档。 - 抓大鹅 Match3D:优先看
docs/prd/AI_NATIVE_MATCH3D_CREATOR_AND_GAMEPLAY_SYSTEM_PRD_2026-04-30.md、MATCH3D_CREATION_AND_RUNTIME_MINIMAL_IMPLEMENTATION_2026-04-30.md和相关 Match3D 技术文档。
个人任务 / 埋点 / 运营查询:
docs/technical/PROFILE_TASK_AND_TRACKING_SYSTEM_2026-05-03.mddocs/technical/RUNTIME_PROFILE_TASK_SCOPE_2026-05-04.mddocs/technical/ANALYTICS_DATE_DIMENSION_IMPLEMENTATION_2026-05-04.mddocs/tracking/TRACKING_QUERY_PLAYBOOK_2026-05-03.mddocs/operations/PROFILE_TASK_QUERY_PLAYBOOK_2026-05-03.md
文档维护规则
- 新增工程实现时,如果已有对应文档,必须同步更新。
- 如果没有对应文档,新文档放入
docs/下合适分类。 .hermes/shared-memory/只保留跨任务、跨成员、高频使用的摘要和索引。- 如果文档与代码冲突,先确认代码事实,再更新过期文档和共享记忆。