使用 Claude Code 进行项目开发:准备、思路与规范

前言

本文不分享在使用 Claude Code 辅助开发时,如何建立一套可复用的工作框架。这套框架的核心思路是:用文档约束 AI,用流程保证质量


一、项目启动前的三项准备

在和 Claude Code 开始写代码之前,建议先准备好三个文件,它们各自承担不同的职责:

1. WorkFlow.md —— 定方向

用途:让 Claude Code 在动手前先理解整个项目的全貌。

  • 梳理项目文件夹结构,明确每个目录/文件的功能和逻辑关系
  • 制定本次开发的工作流程,交给 Claude Code 确认后再执行

核心思路:不要让 AI 盲目开始编码。先让它"读一遍地图",避免做到一半发现方向错了。

2. Review.md —— 定标准

用途:规定代码审查的检查维度和质量标准。

  • 明确什么要删(未使用的函数、多余的导入)
  • 明确什么要改(简化代码、重命名冗长变量)
  • 明确什么要保留(debug 函数、已有注释)

核心思路:AI 生成的代码天然倾向于"完整"而非"简洁"。Review.md 就是用来拉回这条线的。

3. GitInfo.md —— 定归属

用途:记录 Git 仓库信息,包括账号、密码、仓库、分支等,用于让AI自动维护Git。


二、工作思路:四个核心原则(参考

原则一:先思考,再编码

Claude Code 响应很快,但这不意味着应该让它直接开写。在要求它生成代码前,先让它:

  • 列出对需求的理解和假设
  • 指出需求中的模糊之处
  • 提出更简单的替代方案

目的:把问题暴露在编码之前,而不是之后。

原则二:简单优先

这是最重要的一条原则。AI 天然倾向于过度设计——它会在不需要的地方加抽象层、错误处理、可配置项。需要明确告诉它:

  • 不为一次性场景做抽象
  • 不为不可能发生的错误写处理
  • 能用 50 行解决的,别写 200 行

判断标准:如果一个高级工程师看了会说"这也太复杂了",那就是复杂了。

原则三:外科手术式修改

每次修改只动必须动的地方,不"顺带"重构看起来不顺眼的代码。否则 diff 会变得庞大且难以审查,而且容易引入隐藏 bug。

AI 尤其容易犯"顺手优化"的毛病——因为它没有"这是我的代码"的归属感,改起来不心疼。需要约束它只改与当前任务直接相关的行。

原则四:目标驱动

把模糊的需求翻译成可验证的目标:

模糊指令 可验证目标
“代码优化一下” “删除未使用函数,确保测试通过”
“加个功能” “实现 X,满足 Y 条件时触发 Z”

三、代码审查(Review.md)的核心维度

Review.md 是这套框架中最关键的文件之一。它定义了一次代码审查需要检查哪些方面。以下是几个必不可少的维度:

1. 无用代码清理

AI 在迭代开发中容易遗留大量死代码——定义了的函数没调用、导入的库没使用。审查时要系统性地遍历整个项目清理这些东西。但要注意:debug 相关的函数要保留,这是开发阶段的救命工具。

2. 代码简化

审查不只看"对不对",还要看"好不好":

  • 有没有不必要的嵌套?
  • 有没有过长的函数可以拆分或精简?
  • 有没有冗长的命名可以缩短但不丢失语义?

简化的前提是不改变逻辑,纯粹是代码层面的瘦身。

3. 注释质量

AI 的注释有两个极端:要么不写,要么写一堆废话。审查时关注:

  • 重要 API 和关键步骤必须有注释
  • 注释要简洁易懂,不要解释"在做什么"(代码本身能说明),而要解释"为什么这么做"
  • 已有注释不能删——那往往是前人(或之前的自己)花时间想清楚的逻辑

4. 架构合理性

这一步是在更大尺度上审视代码:

  • 函数调用嵌套是否过深?
  • 功能是否可以合并到更合适的模块?
  • 整个文件是否承担了过多的职责?

注意:架构调整要克制,不要为了"完美"而大改。除非当前改动正好触及了某个架构问题,否则留到下次。


四、这套框架的运作逻辑

WorkFlow.md → 定方向(先理解再动手)
       ↓
   编写代码(遵循四大原则)
       ↓
Review.md  → 定标准(逐项审查)
       ↓
   提交/推送

三个文件的本质区别:

文件 回答的问题 何时使用
WorkFlow.md “我们要做什么?怎么做?” 项目开始时
Review.md “做成什么样才算好?” 全过程,尤其是审查阶段
GitInfo.md “代码放哪儿?” 提交时

五、写在最后

这套框架的核心思想并不复杂:用文档弥补 AI 的盲区

AI 不知道你的项目结构,所以有了 WorkFlow.md。
AI 不懂你的代码审美,所以有了 Review.md。
AI 会自动维护你的远程仓库,所以有了 GitInfo.md。

这些文件不是为了记录信息,而是为了对齐预期——让你和 AI 在同一个标准下工作。它们本身也是活的,随着项目演进而更新。

全局 Clauade.md
Review.md
GitInfo.md

Logo

有“AI”的1024 = 2048,欢迎大家加入2048 AI社区

更多推荐