docs: 重新组织文档结构,按开发阶段分类
新的目录结构: 01-项目入门/ # 新人必读,项目基础 02-开发规范/ # 编码标准和规范 03-技术实现/ # 具体开发指导 04-高级开发/ # 进阶开发技巧 05-部署运维/ # 发布和部署 06-功能模块/ # 特定功能文档 新增导航文档: - docs/README.md - 完整的文档导航和使用指南 - 各目录下的README.md - 分类说明和使用指导 优化效果: - 开发者可以按阶段快速定位需要的文档 - 新人有清晰的学习路径 - 不同角色有针对性的文档推荐 - 提供了问题导向的快速查找功能
This commit is contained in:
47
docs/01-项目入门/README.md
Normal file
47
docs/01-项目入门/README.md
Normal file
@@ -0,0 +1,47 @@
|
||||
# 📖 项目入门
|
||||
|
||||
> **适用人群**: 新加入项目的开发者
|
||||
> **使用时机**: 项目开始前,环境搭建阶段
|
||||
|
||||
这个目录包含了新人入门必读的基础文档,帮助你快速了解项目并搭建开发环境。
|
||||
|
||||
## 📋 阅读顺序
|
||||
|
||||
### 第一步:了解项目 🏗️
|
||||
**[项目结构说明.md](项目结构说明.md)**
|
||||
- 项目整体架构设计
|
||||
- 目录组织规则
|
||||
- 各层级职责说明
|
||||
- 团队协作方式
|
||||
|
||||
### 第二步:配置环境 ⚙️
|
||||
**[项目设置指南.md](项目设置指南.md)**
|
||||
- Godot编辑器配置
|
||||
- AutoLoad单例设置
|
||||
- 开发环境验证
|
||||
|
||||
### 第三步:设置控制 🎮
|
||||
**[输入映射配置.md](输入映射配置.md)**
|
||||
- 游戏输入控制配置
|
||||
- 键盘和手柄映射
|
||||
- 输入系统测试
|
||||
|
||||
## ✅ 完成检查
|
||||
|
||||
阅读完本目录的文档后,你应该能够:
|
||||
- [ ] 理解项目的整体架构
|
||||
- [ ] 成功配置Godot开发环境
|
||||
- [ ] 正确设置游戏输入映射
|
||||
- [ ] 运行项目并进行基本测试
|
||||
|
||||
## 🔗 下一步
|
||||
|
||||
完成项目入门后,建议继续阅读:
|
||||
- [02-开发规范](../02-开发规范/) - 学习编码标准
|
||||
- [03-技术实现](../03-技术实现/) - 开始具体开发
|
||||
|
||||
## 💡 小贴士
|
||||
|
||||
- 遇到问题时,先查看对应文档的"常见问题"部分
|
||||
- 建议在实际操作中边读边做,加深理解
|
||||
- 可以将重要的配置信息做笔记备用
|
||||
Reference in New Issue
Block a user