moyin
1ff677b3b2
新的目录结构: 01-项目入门/ # 新人必读，项目基础 02-开发规范/ # 编码标准和规范 03-技术实现/ # 具体开发指导 04-高级开发/ # 进阶开发技巧 05-部署运维/ # 发布和部署 06-功能模块/ # 特定功能文档 新增导航文档: - docs/README.md - 完整的文档导航和使用指南 - 各目录下的README.md - 分类说明和使用指导 优化效果: - 开发者可以按阶段快速定位需要的文档 - 新人有清晰的学习路径 - 不同角色有针对性的文档推荐 - 提供了问题导向的快速查找功能
📚 WhaleTown 项目文档导航
欢迎来到WhaleTown项目文档中心！本文档按开发阶段组织，帮助你快速找到所需的文档。
🗂️ 文档结构
docs/
├── 📖 README.md # 本导航文档
├── 📁 01-项目入门/ # 新人必读，项目基础
├── 📁 02-开发规范/ # 编码标准和规范
├── 📁 03-技术实现/ # 具体开发指导
├── 📁 04-高级开发/ # 进阶开发技巧
├── 📁 05-部署运维/ # 发布和部署
└── 📁 06-功能模块/ # 特定功能文档
🚀 快速开始指南
👋 我是新人，从哪里开始？
推荐阅读顺序：
💻 我要开始编码了
必读文档：
🔧 我需要集成API
相关文档：
🚀 我要发布项目
部署文档：
- Web部署指南 - Web版本发布
📁 详细目录
01-项目入门 📖
适用人群: 新加入项目的开发者
使用时机: 项目开始前，环境搭建阶段
| 文档 | 用途 | 重要程度 |
|---|---|---|
| 项目结构说明.md | 了解项目整体架构和目录组织 | ⭐⭐⭐⭐⭐ |
| 项目设置指南.md | Godot项目配置和AutoLoad设置 | ⭐⭐⭐⭐⭐ |
| 输入映射配置.md | 游戏输入控制配置方法 | ⭐⭐⭐⭐ |
02-开发规范 📋
适用人群: 所有开发者
使用时机: 编码过程中，代码审查时
| 文档 | 用途 | 重要程度 |
|---|---|---|
| 命名规范.md | 统一的命名标准 | ⭐⭐⭐⭐⭐ |
| 代码注释规范.md | 注释格式和标准 | ⭐⭐⭐⭐ |
| Git提交规范.md | 版本控制规范 | ⭐⭐⭐⭐ |
| 架构与通信规范.md | 组件间通信标准 | ⭐⭐⭐⭐⭐ |
| 开发哲学与最佳实践.md | 代码质量和开发理念 | ⭐⭐⭐⭐ |
03-技术实现 🔧
适用人群: 正在开发功能的程序员
使用时机: 具体功能开发时
| 文档 | 用途 | 重要程度 |
|---|---|---|
| 实现细节规范.md | 游戏对象具体实现要求 | ⭐⭐⭐⭐⭐ |
| API接口文档.md | 后端接口说明和使用 | ⭐⭐⭐⭐⭐ |
| 网络管理器设置.md | 网络通信配置 | ⭐⭐⭐⭐ |
| 测试指南.md | 测试方法和工具使用 | ⭐⭐⭐⭐ |
04-高级开发 🚀
适用人群: 有经验的开发者，架构师
使用时机: 复杂功能开发，性能优化时
| 文档 | 用途 | 重要程度 |
|---|---|---|
| 模块开发指南.md | 创建可复用模块的方法 | ⭐⭐⭐ |
| 场景设计规范.md | 场景架构和设计标准 | ⭐⭐⭐ |
| 性能优化指南.md | 游戏性能优化策略 | ⭐⭐⭐ |
05-部署运维 🌐
适用人群: DevOps工程师，项目负责人
使用时机: 项目发布，部署配置时
| 文档 | 用途 | 重要程度 |
|---|---|---|
| Web部署指南.md | Web版本导出和部署 | ⭐⭐⭐⭐ |
06-功能模块 🎮
适用人群: 开发特定功能的程序员
使用时机: 开发对应功能时
| 目录/文档 | 用途 | 重要程度 |
|---|---|---|
| auth/ | 用户认证系统相关文档 | ⭐⭐⭐⭐ |
| └── 表单验证规范.md | 登录注册表单验证规则 | ⭐⭐⭐ |
| └── 认证测试指南.md | 认证功能测试方法 | ⭐⭐⭐ |
🎯 按角色推荐
👨💻 前端开发者
必读: 01-项目入门 → 02-开发规范 → 03-技术实现
选读: 04-高级开发 → 06-功能模块
🏗️ 架构师/技术负责人
必读: 01-项目入门 → 02-开发规范 → 04-高级开发
选读: 03-技术实现 → 05-部署运维
🧪 测试工程师
必读: 01-项目入门 → 03-技术实现/测试指南.md
选读: 06-功能模块
🚀 DevOps工程师
必读: 01-项目入门 → 05-部署运维
选读: 03-技术实现
🔍 快速查找
按问题类型查找
🤔 "我不知道项目是怎么组织的" → 项目结构说明.md
🤔 "我不知道怎么命名变量/函数" → 命名规范.md
🤔 "我不知道怎么让组件之间通信" → 架构与通信规范.md
🤔 "我不知道怎么实现玩家/NPC" → 实现细节规范.md
🤔 "我不知道怎么调用API" → API接口文档.md
🤔 "我不知道怎么测试功能" → 测试指南.md
🤔 "我不知道怎么发布项目" → Web部署指南.md
📝 文档维护
更新频率
- 01-项目入门: 项目架构变更时更新
- 02-开发规范: 团队规范调整时更新
- 03-技术实现: API变更或新功能时更新
- 04-高级开发: 最佳实践演进时更新
- 05-部署运维: 部署流程变更时更新
- 06-功能模块: 对应功能开发时更新
贡献指南
如果你发现文档有问题或需要补充：
- 创建Issue描述问题
- 提交PR修改文档
- 遵循Git提交规范
💡 提示: 建议将本导航页面加入书签，方便随时查阅！