docs: 新增 README.md 模板库使用说明
- 添加模板库简介和使用指南 - 包含 11 个模板清单和适用场景 - 快速开始教程 - 模板结构和填写规范 - AI 协作说明 - 目录结构建议 - 更新流程规范
This commit is contained in:
226
README.md
Normal file
226
README.md
Normal file
@@ -0,0 +1,226 @@
|
||||
# 游戏策划文档模板库
|
||||
|
||||
> 专业、全面、AI 友好的游戏策划文档模板集合
|
||||
|
||||
**版本:** v1.0
|
||||
**最后更新:** 2026-03-18
|
||||
**维护团队:** 游戏策划工作室
|
||||
|
||||
---
|
||||
|
||||
## 📖 简介
|
||||
|
||||
本模板库提供 **11 个专业游戏策划文档模板**,覆盖游戏设计的全流程:
|
||||
|
||||
- ✅ 系统设计类(关卡、UI/UX、战斗、技能)
|
||||
- ✅ 数值经济类(数值设计、经济系统)
|
||||
- ✅ 叙事内容类(世界观、角色、剧情)
|
||||
- ✅ 商业化运营类(商业化设计、活动策划)
|
||||
|
||||
所有模板采用 **标准 Markdown 格式**,AI agent 可直接读取和处理,同时适合人类策划人员使用。
|
||||
|
||||
---
|
||||
|
||||
## 📁 模板清单
|
||||
|
||||
| # | 模板名称 | 文件 | 适用场景 |
|
||||
|---|----------|------|----------|
|
||||
| 1 | 关卡设计文档 | `【模板】关卡设计文档.md` | 关卡/副本/地图设计 |
|
||||
| 2 | UI/UX 设计文档 | `【模板】UIUX 设计文档.md` | 界面/交互/视觉规范 |
|
||||
| 3 | 数值设计文档 | `【模板】数值设计文档.md` | 属性/成长/战斗公式 |
|
||||
| 4 | 经济系统设计文档 | `【模板】经济系统设计文档.md` | 货币/资源/付费点 |
|
||||
| 5 | 战斗系统设计文档 | `【模板】战斗系统设计文档.md` | 战斗机制/AI/规则 |
|
||||
| 6 | 技能设计文档 | `【模板】技能设计文档.md` | 技能/天赋/Buff |
|
||||
| 7 | 世界观设定文档 | `【模板】世界观设定文档.md` | 世界背景/地理/势力 |
|
||||
| 8 | 角色设定文档 | `【模板】角色设定文档.md` | 角色档案/性格/关系 |
|
||||
| 9 | 剧情大纲文档 | `【模板】剧情大纲文档.md` | 主线/支线/对话 |
|
||||
| 10 | 商业化设计文档 | `【模板】商业化设计文档.md` | 付费点/定价/分层 |
|
||||
| 11 | 活动策划文档 | `【模板】活动策划文档.md` | 运营活动/排期/评估 |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 1. 克隆仓库
|
||||
|
||||
```bash
|
||||
git clone http://git.joywaygames.cn:3000/basegames/gamedesign-docs-templates.git
|
||||
cd gamedesign-docs-templates
|
||||
```
|
||||
|
||||
### 2. 选择模板
|
||||
|
||||
根据设计需求选择对应模板:
|
||||
|
||||
```bash
|
||||
# 示例:创建新关卡设计文档
|
||||
cp templates/【模板】关卡设计文档.md projects/我的项目/关卡 01 设计.md
|
||||
```
|
||||
|
||||
### 3. 填充内容
|
||||
|
||||
打开模板文件,替换 `[占位符]` 为实际内容:
|
||||
|
||||
```markdown
|
||||
# 【项目 -XXX】关卡设计文档
|
||||
|
||||
**关卡名称:** 第一章 - 初出茅庐 ← 替换
|
||||
**所属项目:** 我的游戏项目 ← 替换
|
||||
**关卡类型:** 主线关卡 ← 选择
|
||||
...
|
||||
```
|
||||
|
||||
### 4. 提交文档
|
||||
|
||||
```bash
|
||||
git add projects/我的项目/关卡 01 设计.md
|
||||
git commit -m "feat: 新增第一章关卡设计文档"
|
||||
git push
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📋 模板结构说明
|
||||
|
||||
每个模板包含以下核心模块:
|
||||
|
||||
### 基础信息
|
||||
- 文档元数据(名称、版本、负责人)
|
||||
- 设计目标与原则
|
||||
- 前置条件/适用范围
|
||||
|
||||
### 核心设计
|
||||
- 详细设计内容(因模板类型而异)
|
||||
- 表格、流程图、公式
|
||||
- 配置参数与规则
|
||||
|
||||
### 验证与测试
|
||||
- 设计验证清单
|
||||
- 测试要点
|
||||
- 平衡性检查
|
||||
|
||||
### 变更记录
|
||||
- 版本历史
|
||||
- 修改记录
|
||||
|
||||
---
|
||||
|
||||
## 🎯 使用规范
|
||||
|
||||
### 文档命名
|
||||
|
||||
| 类型 | 命名格式 | 示例 |
|
||||
|------|----------|------|
|
||||
| 模板 | `【模板】XXX 文档.md` | `【模板】关卡设计文档.md` |
|
||||
| 项目文档 | `【项目-XXX】XXX 文档.md` | `【项目 - 原神】关卡设计.md` |
|
||||
| 竞品分析 | `【竞品分析】游戏名 - 内容.md` | `【竞品分析】原神 - 核心玩法.md` |
|
||||
|
||||
### 版本管理
|
||||
|
||||
- **主版本 (v1.0)** - 重大修改
|
||||
- **次版本 (v1.1)** - 内容增补
|
||||
- **修订版 (v1.1.1)** - 错别字/格式修正
|
||||
|
||||
### 填写规范
|
||||
|
||||
1. **占位符** - `[填写内容]` 必须替换
|
||||
2. **可选内容** - `[可选]` 根据需求选择
|
||||
3. **表格** - 保持格式对齐
|
||||
4. **公式** - 使用代码块包裹
|
||||
|
||||
---
|
||||
|
||||
## 🤖 AI 协作
|
||||
|
||||
### AI 可读格式
|
||||
|
||||
模板采用标准 Markdown,AI agent 可直接读取:
|
||||
|
||||
```bash
|
||||
# AI 读取示例
|
||||
ai-agent read templates/【模板】关卡设计文档.md
|
||||
ai-agent generate --template=关卡设计 --game=我的游戏
|
||||
```
|
||||
|
||||
### 与 AI 策划配合
|
||||
|
||||
1. **任务下发** - 将模板发送给 AI 策划 agent
|
||||
2. **内容生成** - AI 填充初稿
|
||||
3. **人工审核** - 策划审核调整
|
||||
4. **版本提交** - 提交到 Git 仓库
|
||||
|
||||
---
|
||||
|
||||
## 📁 推荐目录结构
|
||||
|
||||
```
|
||||
gamedesign-docs-templates/
|
||||
├── templates/ # 模板文件(本仓库)
|
||||
├── projects/ # 项目文档
|
||||
│ ├── 项目 A/
|
||||
│ │ ├── 系统设计/
|
||||
│ │ ├── 数值设计/
|
||||
│ │ └── 剧情设计/
|
||||
│ └── 项目 B/
|
||||
├── competitive-analysis/ # 竞品分析
|
||||
├── standards/ # 规范标准
|
||||
└── README.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔄 更新流程
|
||||
|
||||
### 模板更新
|
||||
|
||||
1. **提出修改** - 在对应模板文件修改
|
||||
2. **测试验证** - 用实际项目验证模板
|
||||
3. **提交审核** - 提交 PR 或直接 commit
|
||||
4. **版本升级** - 更新版本号
|
||||
|
||||
### 新增模板
|
||||
|
||||
1. **创建文件** - `templates/【模板】新模板.md`
|
||||
2. **更新清单** - 在 README.md 添加记录
|
||||
3. **提交审核** - 团队审核后合并
|
||||
|
||||
---
|
||||
|
||||
## 📊 统计信息
|
||||
|
||||
| 指标 | 数值 |
|
||||
|------|------|
|
||||
| 模板数量 | 11 个 |
|
||||
| 总行数 | 3766 行 |
|
||||
| 覆盖领域 | 5 大类 |
|
||||
| 文件格式 | Markdown (.md) |
|
||||
|
||||
---
|
||||
|
||||
## 📝 变更日志
|
||||
|
||||
### v1.0 (2026-03-18)
|
||||
|
||||
**初始化版本**
|
||||
- ✅ 新增 11 个专业策划模板
|
||||
- ✅ 覆盖系统设计、数值、战斗、叙事、商业化
|
||||
- ✅ AI 友好格式,标准 Markdown
|
||||
- ✅ Git 版本管理配置
|
||||
|
||||
---
|
||||
|
||||
## 📞 反馈与支持
|
||||
|
||||
- **问题反馈:** 在 Git 仓库提交 Issue
|
||||
- **模板建议:** 联系游戏策划工作室
|
||||
- **文档链接:** [Git 仓库](http://git.joywaygames.cn:3000/basegames/gamedesign-docs-templates)
|
||||
|
||||
---
|
||||
|
||||
## 📄 许可证
|
||||
|
||||
本模板库仅供内部使用,未经许可不得外传。
|
||||
|
||||
---
|
||||
|
||||
*文档由游戏策划工作室自动生成和维护*
|
||||
Reference in New Issue
Block a user