template/docs/getting-started.md

Claude Enterprise Framework - 快速开始指南

🚀 5分钟快速体验

前提条件

确保你的开发环境已安装：

• Git (版本控制)
• Java 21 (用于Java项目)
• Maven 3.9+ (用于Java项目构建)
• Docker (用于数据库和集成测试)
• Claude Desktop 或 Claude API访问

步骤1: 获取框架

# 克隆框架到本地
git clone https://github.com/your-org/claude-enterprise-framework.git
cd claude-enterprise-framework

# 查看框架结构
ls -la

步骤2: 初始化你的第一个项目

# 创建一个医疗健康管理系统示例
./scripts/init-project.sh \
  --name "health-management-system" \
  --template java-spring-boot \
  --package "com.hospital.health" \
  --stack java21-springboot3-mysql \
  --industry healthcare

# 进入项目目录  
cd health-management-system

步骤3: 验证项目结构

# 查看生成的项目结构
tree -L 3

# 检查Claude配置
cat CLAUDE.md

# 验证依赖和编译
mvn compile

步骤4: 开始AI驱动开发

4.1 需求分析

创建一个需求文档 requirements.md：

# 用户管理模块需求

## 业务背景
医院需要一个统一的用户管理系统，管理医生、护士和患者的账号信息。

## 功能要求
1. 用户注册和登录
2. 角色权限管理  
3. 个人信息维护
4. 密码安全策略

## 非功能要求
- 支持1000+并发用户
- 99.9%系统可用性
- 符合医疗数据安全标准

4.2 使用Claude进行需求分析

# 方法1: 直接使用Claude Desktop
# 复制 claude-framework/prompt-templates/analysis.md 的内容
# 替换变量后输入给Claude

# 方法2: 使用命令行工具 (如果配置了claude-cli)
claude --template analysis --input requirements.md --output analysis-result.md

4.3 生成实现代码

基于分析结果，使用实现模板：

# 使用Claude生成完整的用户管理模块代码
claude --template implementation \
  --input analysis-result.md \
  --output user-module-implementation/

步骤5: 运行质量检查

# 运行完整的质量门禁检查
mvn verify

# 单独运行各项检查
mvn test                    # 单元测试
mvn checkstyle:check       # 代码风格检查  
mvn spotbugs:check         # 静态分析
mvn jacoco:report          # 测试覆盖率

# 查看测试报告
open target/site/jacoco/index.html

步骤6: 启动应用

# 启动MySQL数据库 (使用Docker)
docker run -d --name mysql-dev \
  -e MYSQL_ROOT_PASSWORD=password \
  -e MYSQL_DATABASE=health_management_system \
  -p 3306:3306 \
  mysql:8.0

# 运行数据库迁移
mvn flyway:migrate

# 启动应用
mvn spring-boot:run

# 访问应用
open http://localhost:8080
open http://localhost:8080/swagger-ui.html  # API文档

🎯 核心工作流演示

完整开发流程示例

以"患者预约管理"功能为例：

1. 需求分析阶段

# 创建需求文档
cat > appointment-requirements.md << 'EOF'
# 患者预约管理功能需求

## 业务目标
- 患者可以在线预约医生
- 医生可以管理预约时间表  
- 系统自动处理预约冲突

## 用户角色
- 患者: 预约、取消、查看预约
- 医生: 设置可预约时间、确认预约
- 管理员: 监控预约统计

## 业务流程
1. 患者选择科室和医生
2. 查看医生可预约时间段
3. 选择时间并提交预约
4. 系统验证并确认预约
5. 发送确认通知
EOF

# 使用Claude分析需求 (需要手动执行)
echo "请将 claude-framework/prompt-templates/analysis.md 内容复制给Claude"
echo "并将 appointment-requirements.md 作为输入"

2. 架构设计阶段

# 基于需求分析结果，进行领域建模和架构设计
echo "使用 design.md 模板进行架构设计"
echo "输出: 聚合设计、数据模型、API接口定义"

3. 实现生成阶段

# 使用implementation.md模板生成代码
echo "生成以下文件:"
echo "- AppointmentEntity.java"
echo "- AppointmentRepository.java"  
echo "- AppointmentService.java"
echo "- AppointmentController.java"
echo "- 对应的单元测试"
echo "- Flyway数据库迁移脚本"

4. 验证与集成

# 编译检查
mvn compile

# 运行测试
mvn test

# 数据库迁移
mvn flyway:migrate

# 集成测试
mvn verify

# 启动应用验证
mvn spring-boot:run

📚 深入学习路径

初学者路径 (第1-2周)

1. 了解框架理念

   • 阅读 01-overview-principles.md
   • 理解AI驱动开发的5大原则

2. 熟悉工作流程

   • 学习 03-workflow-phases.md
   • 掌握6阶段开发流程

3. 实践基础功能

   • 完成用户管理模块开发
   • 学习Prompt模板的使用

进阶路径 (第3-4周)

1. 质量体系掌握

   • 学习 04-quality-metrics.md
   • 建立质量监控仪表板

2. 自检机制应用

   • 掌握 05-self-review.md
   • 提升Claude输出质量

3. 复杂功能开发

   • 开发业务逻辑复杂的模块
   • 应用DDD领域建模

专家路径 (第5-8周)

1. 框架定制

   • 学习 customization.md
   • 为特定行业定制框架

2. 团队协作

   • 建立团队开发规范
   • 配置CI/CD流水线

3. 持续改进

   • 建立反馈机制
   • 优化Prompt Pack

🔧 常见问题解决

Q1: 初始化项目失败

# 检查前提条件
java --version  # 应该是21+
mvn --version   # 应该是3.9+
git --version

# 检查权限
chmod +x scripts/*.sh

# 查看详细错误
./scripts/init-project.sh --help

Q2: Maven构建失败

# 清理并重新构建
mvn clean compile

# 检查依赖
mvn dependency:tree

# 跳过测试构建
mvn compile -DskipTests

Q3: 数据库连接问题

# 检查MySQL是否启动
docker ps | grep mysql

# 重启数据库
docker restart mysql-dev

# 检查连接配置
cat src/main/resources/application-dev.yml

Q4: Claude输出质量不佳

# 检查Prompt模板版本
cat claude-project.yml

# 更新模板到最新版本
git pull origin main

# 查看自检报告改进建议

📈 成功指标

完成快速开始后，你应该达到：

指标	目标值	验证方式
项目初始化成功率	100%	应用能正常启动
Claude输出可用性	90%+	生成代码能编译通过
测试覆盖率	70%+	JaCoCo报告显示
API文档完整性	100%	Swagger UI显示完整

🎉 下一步

恭喜！你已经掌握了Claude Enterprise Framework的基本用法。

推荐后续学习:

• 深入学习 框架架构
• 了解 定制化选项
• 查看更多 示例项目
• 参与 社区讨论

开始构建你的下一个AI驱动项目吧！ 🚀