Skip to content

darcula1993/AI_Coding_guide

Repository files navigation

AI Coding 指南

一个系统性的AI协作开发实践指南,帮助开发者掌握与AI高效协作的方法和技巧。

🎯 指南定位: 面向有一定编程基础的开发者,专注于AI辅助开发的实践方法论,而非具体技术实现。

📖 内容特色: 以对话式案例为主,理论与实践相结合,注重可操作性和实用性。

📚 目录结构

章节 标题 核心内容
01 概述与核心理念 AI协作基础概念、渐进式开发原则
02 项目初始化与架构设计 架构优先设计、AI友好的项目结构
03 版本控制与协作策略 Git工作流、风险控制、协作模式
04 高效沟通的艺术 AI协作沟通技巧、上下文管理
05 模块化设计的智慧 业务驱动模块化、接口优先设计
06 代码标准与协作规范 命名规范、注释标准、文档规范

🎯 核心理念

AI是协作伙伴,不是替代品

  • AI擅长: 快速生成代码框架、处理重复性任务、提供多种解决方案
  • 人类负责: 明确需求定义、架构指导、质量把控、业务逻辑验证

渐进式开发原则

# ❌ 错误做法:一次性大需求
"请帮我实现一个完整的用户管理系统"

# ✅ 正确做法:分步骤实现
"Step 1: 先实现用户模型和基础CRUD操作"
"Step 2: 添加用户注册功能"
"Step 3: 实现登录验证"

🚀 快速开始

1. 建立正确的协作模式

Human: 我需要为Flask应用添加用户认证功能,项目使用SQLAlchemy和JWT。

AI: 我来帮你实现用户认证功能。首先让我了解一下:
1. 你的User模型是否已经存在?
2. 是否已经配置了JWT?
3. 希望使用哪种认证方式?

2. 遵循版本控制规范

# 创建功能分支
git checkout -b feature/user-auth-ai-assisted

# 规范的提交信息
git commit -m "feat(auth): implement JWT token validation

- Add token validation middleware
- Include token refresh mechanism
- Add unit tests for auth functions

AI-Generated: 85%
Human-Reviewed: 100%"

3. 代码审查检查清单

  • 输入验证和异常处理
  • 安全性检查(避免SQL注入、XSS等)
  • 性能优化(避免N+1查询)
  • 代码可读性和维护性
  • 单元测试覆盖

💡 核心方法论

🏗️ 架构驱动开发

  • 架构优先: 先设计整体架构,再逐步实现
  • 模块化思维: 业务功能驱动的模块划分
  • 接口优先: 定义清晰的模块间契约

🤝 协作沟通策略

  • 上下文管理: 为AI提供充分的项目背景
  • 渐进式澄清: 逐步明确需求细节
  • 结构化对话: 使用标准化的沟通模式

📋 标准化规范

  • 命名约定: 自解释的命名策略
  • 文档标准: AI友好的注释和文档格式
  • 版本控制: 语义化的提交信息规范

✅ 推荐做法

  • 明确需求边界,分步骤实现功能
  • 建立标准化的代码和文档规范
  • 保持人工审查,特别关注安全性和业务逻辑
  • 使用版本控制记录每次AI协作的变更

❌ 避免陷阱

  • 过度依赖AI,缺乏人工判断
  • 一次性处理复杂需求,缺少拆解
  • 跳过代码审查,直接部署AI生成的代码
  • 忽视项目标准,产生不一致的代码风格

🛠️ 推荐工具链

代码标准化

  • 格式化: Black (Python), Prettier (JS), gofmt (Go)
  • 静态检查: Flake8, ESLint, SonarQube
  • 提交规范: Conventional Commits, pre-commit hooks

文档和协作

  • API文档: OpenAPI/Swagger, Postman
  • 项目文档: Markdown, MkDocs, GitBook
  • 版本管理: Git, 语义化版本控制

AI协作辅助

  • 代码生成: GitHub Copilot, Claude Code, Cursor
  • 代码审查: AI-powered review tools
  • 文档生成: AI文档助手

🤝 贡献指南

欢迎提交Issue和Pull Request来完善这个指南!

📄 许可证

本项目采用 MIT 许可证。


开始你的AI协作开发之旅! 🚀

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published