# Docs

**Repository Path**: dual-escape-game/docs

## Basic Information

- **Project Name**: Docs
- **Description**: 文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-13
- **Last Updated**: 2026-04-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DualEscape AI 文档仓库

本仓库用于维护《DualEscape AI》的需求、规则、技术与联调文档。

## 1. 推荐阅读顺序

1. `项目文档/PRD.md`：先理解产品范围与 MVP 边界
2. `项目文档/技术方案.md`：再看工程落地方案
3. `项目文档/游戏规则.md`：最后对齐可执行规则

若你要直接开始本地联调，请额外阅读：

1. `项目文档/本地开发环境变量说明.md`
2. `项目文档/RESTful最小联调契约.md`
3. `项目文档/本地联调与自测清单.md`
4. `项目文档/本地Docker开发方案.md`
5. `项目文档/交互设计文档.md`

## 2. 本地开发最小闭环（文档驱动）

当代码仓与文档仓分离时，建议按以下顺序在本地联调：

1. 在代码仓创建 `.env.local`，按 `项目文档/本地开发环境变量说明.md` 填写变量
2. 若使用 Docker 依赖，先按 `项目文档/本地Docker开发方案.md` 拉起 Redis/PostgreSQL
3. 启动后端服务与前端页面（命令以代码仓实际脚本为准）
4. 按 `项目文档/RESTful最小联调契约.md` 对齐接口字段
5. 按 `项目文档/本地联调与自测清单.md` 执行 6 组核心回归

## 3. 文档维护规则

1. 规则改动先改 `PRD.md` 与 `技术方案.md`，再改专题分册
2. 任何 REST 接口字段改动必须同步更新 `RESTful最小联调契约.md`
3. 任何超时/断线/AI 降级策略改动必须同步更新自测清单

## 4. 贡献方式

1. 创建分支并修改文档
2. 在 PR 描述中说明修改动机、影响范围、同步更新点
3. 确保 `项目文档/文档索引.md` 已包含新增文档