Skip to content

我的开发经验+vibe-coding 的中文翻译版本

License

Notifications You must be signed in to change notification settings

kansonkong/vibe-coding-cn

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Vibe Coding 指南

Vibe Coding 终极指南 V1.2

一个通过与 AI 结对编程,将想法变为现实的终极工作流程。


构建状态 最新版本 许可证 主要语言 代码大小 贡献者 交流群

📚 相关文档🚀 入门指南⚙️ 完整设置流程🤝 参与贡献


🖼️ 概览

Vibe Coding 是一个与 AI 结对编程的终极工作流程,旨在帮助开发者丝滑地将想法变为现实。本指南详细介绍了从项目构思、技术选型、实施规划到具体开发、调试和扩展的全过程,强调以规划驱动模块化为核心,避免让 AI 失控导致项目混乱。

核心理念: 规划就是一切。 绝不要让 AI 自主规划,否则你的代码库会变成一团无法管理的乱麻。


📚 相关文档/资源


✉️ 联系方式


项目目录结构概览

本项目 vibe-coding-cn 的核心结构主要围绕知识管理、AI 提示词的组织与自动化展开。以下是经过整理和简化的目录树及各部分说明:

.
├── CODE_OF_CONDUCT.md           # 社区行为准则,规范贡献者行为。
├── CONTRIBUTING.md              # 贡献指南,说明如何为本项目做出贡献。
├── LICENSE                      # 开源许可证文件。
├── Makefile                     # 项目自动化脚本,用于代码检查、构建等。
├── README.md                    # 项目主文档,包含项目概览、使用指南、资源链接等。
├── .gitignore                   # Git 忽略文件。
│
├── documents/                   # 存放各类说明文档、经验总结和配置详细说明。
│   ├── auggie-mcp配置文档.md      # Augment 上下文引擎配置文档。
│   ├── 代码组织.md                # 代码组织与结构相关文档。
│   ├── ... (其他文档)
│
├── prompts/                     # 集中存放所有类型的 AI 提示词。
│   ├── assistant_prompts/       # 辅助类提示词。
│   ├── coding_prompts/          # 专门用于编程和代码生成相关的提示词集合。
│   │   ├── ... (具体编程提示词文件)
│   │
│   ├── prompts-library/         # 提示词库管理工具(Excel-Markdown 转换)
│   │   ├── main.py              # 提示词库管理工具主入口。
│   │   ├── scripts/             # 包含 Excel 与 Markdown 互转脚本和配置。
│   │   ├── prompt_excel/        # 存放 Excel 格式的原始提示词数据。
│   │   ├── prompt_docs/         # 存放从 Excel 转换而来的 Markdown 提示词文档。
│   │   ├── ... (其他 prompts-library 内部文件)
│   │
│   ├── system_prompts/          # AI 系统级提示词,用于设定 AI 行为和框架。
│   │   ├── CLAUDE.md/           # (注意:此路径下文件和目录同名,可能需用户确认)
│   │   ├── ... (其他系统提示词)
│   │
│   └── user_prompts/            # 用户自定义或常用提示词。
│       ├── ASCII图生成.md         # ASCII 艺术图生成提示词。
│       ├── 数据管道.md            # 数据管道处理提示词。
│       ├── ... (其他用户提示词)
│
└── backups/                     # 项目备份脚本。
    ├── 一键备份.sh                # 一键执行备份的 Shell 脚本。
    └── 快速备份.py                # 实际执行逻辑的 Python 脚本。

🖼️ 概览与演示

一句话:Vibe Coding = 规划驱动 + 上下文固定 + AI 结对执行,让「从想法到可维护代码」变成一条可审计的流水线,而不是一团无法迭代的巨石文件。

你能得到

  • 成体系的提示词工具链:prompts/system_prompts/ 约束 AI 行为边界,prompts/coding_prompts/ 提供需求澄清、计划、执行的全链路脚本。
  • 闭环交付路径:需求 → 上下文文档 → 实施计划 → 分步实现 → 自测 → 进度记录,全程可复盘、可移交。
  • 共享记忆库:在 memory-bank/(或你的等价目录)同步 project-context.mdprogress.md 等,让人类与 AI 共用同一真相源。

3 分钟 CLI 演示(在 Codex CLI / Claude Code 中按顺序执行即可)

  1. 复制你的需求,加载 prompts/coding_prompts/(1,1)_#_📘_项目上下文文档生成_·_工程化_Prompt(专业优化版).md 生成 project-context.md
  2. 加载 prompts/coding_prompts/(3,1)_#_流程标准化.md,得到可执行的实施计划与每步验收方式。
  3. 使用 prompts/coding_prompts/(5,1)_{content#_🚀_智能需求理解与研发导航引擎(Meta_R&D_Navigator_·.md 驱动 AI 按计划写代码;每完成一项就更新 progress.md 并运行计划中的测试或 make test

录屏要点(便于替换成 GIF)

  • 画面 1:粘贴需求 → 自动生成上下文文档。
  • 画面 2:生成实施计划,勾选 3–5 个任务。
  • 画面 3:AI 写出首个模块并跑通测试结果。
  • 建议将录屏保存为 documents/assets/vibe-coding-demo.gif,再替换下方链接。

Vibe Coding 三步演示

演示剧本(文字版,可直接喂给 AI 使用)

  • 需求示例:帮我用 FastAPI 写一个带 Redis 缓存的天气查询服务(含 Dockerfile 和基础测试)。
  • 提醒 AI:按上述 1→2→3 的 prompt 顺序执行;每一步必须给出验收指令;禁止生成单文件巨石。
  • 验收标准:接口返回示例、docker buildpytest 全部通过;README 需补充使用说明与架构摘要。

想快速试水,把自己的需求原样贴给 AI,按 1-2-3 的 prompt 串起来,就能得到可落地、可验证、可维护的交付流程。


⚙️ 架构与工作流程

核心资产映射(排除 GITHUB/):

prompts/
  coding_prompts/        # 需求澄清、计划、执行链的核心提示词
  system_prompts/        # 约束 AI 行为边界的系统级提示词
  assistant_prompts/     # 辅助/配合型提示
  user_prompts/          # 可复用的用户侧提示词
  prompts-library/       # Excel↔Markdown 提示词转换与索引工具
documents/
  代码组织.md, 通用项目架构模板.md, 开发经验.md, 系统提示词构建原则.md 等知识库
backups/
  一键备份.sh, 快速备份.py  # 本地/远端快照脚本
graph TB
  %% 语义样式
  classDef dataFlow stroke:#1565c0,stroke-width:2px;
  classDef control stroke-dasharray: 3 3,stroke:#8e24aa,stroke-width:1.6px;
  classDef async stroke-dasharray: 2 4,stroke:#2e7d32,stroke-width:1.6px;

  subgraph 🌍 外部系统与数据源层
    ext_contrib[社区贡献者]
    ext_sheet[Google表格 / 外部表格数据]
    ext_md[外部 Markdown 提示词]
    ext_api[未来可扩展数据源 / API]
    ext_contrib --> ext_sheet
    ext_contrib --> ext_md
    ext_api -.-> ext_sheet
  end

  subgraph 🔍 数据接入与采集层
    excel_raw[prompt_excel/*.xlsx 原始表]
    md_raw[prompt_docs/外部MD输入]
    excel_to_docs[prompts-library/scripts/excel_to_docs.py]
    docs_to_excel[prompts-library/scripts/docs_to_excel.py]
    ingest_bus[标准化数据帧]
    ext_sheet --> excel_raw
    ext_md --> md_raw
    excel_raw --> excel_to_docs
    md_raw --> docs_to_excel
    excel_to_docs --> ingest_bus
    docs_to_excel --> ingest_bus
  end

  subgraph ⚙️ 数据处理与智能决策层(核心)
    validate[字段校验与规范化] --> transform[格式映射转换引擎]
    transform --> artifacts_md[生成 prompt_docs/规范MD]
    transform --> artifacts_xlsx[生成 prompt_excel/导出XLSX]
    orchestrator[main.py · scripts/start_convert.py 调度] -.-> validate
    orchestrator -.-> transform
    ingest_bus --> validate
  end

  subgraph 📥 执行与消费层
    artifacts_md --> catalog_coding[prompts/coding_prompts 编程链路提示词]
    artifacts_md --> catalog_system[prompts/system_prompts 行为约束提示词]
    artifacts_md --> catalog_assist[prompts/assistant_prompts 辅助提示词]
    artifacts_md --> catalog_user[prompts/user_prompts 用户提示词]
    artifacts_md --> docs_repo[documents/* 知识库引用]
    artifacts_md -.-> new_consumer[其他下游/发布渠道]
    catalog_coding --> ai_flow[AI 结对编程流程]
    ai_flow --> deliverables[项目上下文 / 计划 / 代码产出]
  end

  subgraph 👥 用户交互与接口层
    cli[CLI: python main.py] --> orchestrator
    makefile[Makefile 任务封装] -.-> cli
    readme[README.md 使用指南] -.-> cli
  end

  subgraph 🧱 基础设施与横切能力层
    git[Git 版本控制] -.-> orchestrator
    backups[backups/一键备份.sh · backups/快速备份.py] -.-> artifacts_md
    deps[requirements.txt · scripts/requirements.txt 依赖] -.-> orchestrator
    config[prompts-library/scripts/config.yaml 配置] -.-> orchestrator
    monitor[日志/监控(外部接入预留)] -.-> orchestrator
  end

  %% 横切覆盖示意
  backups -.-> catalog_coding
  git -.-> validate
  config -.-> validate

  %% Legend
  subgraph Legend[Legend]
    legend_data[实线箭头:主数据流]
    legend_ctrl[虚线:控制/配置/调度]
    legend_async[点虚线:外部/异步接口]
  end
Loading

📈 性能基准 (可选)

本仓库定位为「流程与提示词」而非性能型代码库,建议跟踪下列可观测指标(当前主要依赖人工记录,可在 progress.md 中打分/留痕):

指标 含义 当前状态/建议
提示命中率 一次生成即满足验收的比例 待记录;每个任务完成后在 progress.md 记 0/1
周转时间 需求 → 首个可运行版本所需时间 录屏时标注时间戳,或用 CLI 定时器统计
变更可复盘度 是否同步更新上下文/进度/备份 通过手工更新;可在 backups 脚本中加入 git tag/快照
例程覆盖 是否有最小可运行示例/测试 建议每个示例项目保留 README+测试用例

🗺️ 路线图

gantt
    title 项目发展路线图
    dateFormat YYYY-MM
    section 近期 (2025)
    补全演示GIF与示例项目: active, 2025-12, 15d
    prompts 索引自动生成脚本: 2025-12, 10d
    section 中期 (2026 Q1)
    一键演示/验证 CLI 工作流: 2026-01, 15d
    备份脚本增加快照与校验: 2026-01, 10d
    section 远期 (2026 Q1-Q2)
    模板化示例项目集: 2026-02, 20d
    多模型对比与评估基线: 2026-02, 20d
Loading

🚀 入门指南(这里是原作者的,不是我写的,我更新了一下我认为最好的模型)

要开始 Vibe Coding,你只需要以下两种工具之一:

  • Claude Opus 4.5,在 Claude Code 中使用
  • gpt-5.1-codex.1-codex (xhigh),在 Codex CLI 中使用

本指南同时适用于 CLI 终端版本和 VSCode 扩展版本(Codex 和 Claude Code 都有扩展,且界面更新)。

(注:本指南早期版本使用的是 Grok 3,后来切换到 Gemini 2.5 Pro,现在我们使用的是 Claude 4.5(或 gpt-5.1-codex.1-codex (xhigh)))

(注2:如果你想使用 Cursor,请查看本指南的 1.1 版本,但我们认为它目前不如 Codex CLI 或 Claude Code 强大)


⚙️ 完整设置流程
1. 游戏设计文档(Game Design Document)
  • 把你的游戏创意交给 gpt-5.1-codexClaude Opus 4.5,让它生成一份简洁的 游戏设计文档,格式为 Markdown,文件名为 game-design-document.md
  • 自己审阅并完善,确保与你的愿景一致。初期可以很简陋,目标是给 AI 提供游戏结构和意图的上下文。不要过度设计,后续会迭代。
2. 技术栈与 CLAUDE.md / Agents.md
  • gpt-5.1-codexClaude Opus 4.5 为你的游戏推荐最合适的技术栈(例如:多人3D游戏用 ThreeJS + WebSocket),保存为 tech-stack.md
    • 要求它提出 最简单但最健壮 的技术栈。
  • 在终端中打开 Claude CodeCodex CLI,使用 /init 命令,它会读取你已创建的两个 .md 文件,生成一套规则来正确引导大模型。
  • 关键:一定要审查生成的规则。 确保规则强调 模块化(多文件)和禁止 单体巨文件(monolith)。可能需要手动修改或补充规则。
    • 极其重要: 某些规则必须设为 "Always"(始终应用),确保 AI 在生成任何代码前都强制阅读。例如添加以下规则并标记为 "Always":
      # 重要提示:
      # 写任何代码前必须完整阅读 memory-bank/@architecture.md(包含完整数据库结构)
      # 写任何代码前必须完整阅读 memory-bank/@game-design-document.md
      # 每完成一个重大功能或里程碑后,必须更新 memory-bank/@architecture.md
      
    • 其他(非 Always)规则要引导 AI 遵循你技术栈的最佳实践(如网络、状态管理等)。
    • 如果想要代码最干净、项目最优化,这一整套规则设置是强制性的。
3. 实施计划(Implementation Plan)
  • 将以下内容提供给 gpt-5.1-codexClaude Opus 4.5
    • 游戏设计文档(game-design-document.md
    • 技术栈推荐(tech-stack.md
  • 让它生成一份详细的 实施计划(Markdown 格式),包含一系列给 AI 开发者的分步指令。
    • 每一步要小而具体。
    • 每一步都必须包含验证正确性的测试。
    • 严禁包含代码——只写清晰、具体的指令。
    • 先聚焦于 基础游戏,完整功能后面再加。
4. 记忆库(Memory Bank)
  • 新建项目文件夹,并在 VSCode 中打开。
  • 在项目根目录下创建子文件夹 memory-bank
  • 将以下文件放入 memory-bank
    • game-design-document.md
    • tech-stack.md
    • implementation-plan.md
    • progress.md(新建一个空文件,用于记录已完成步骤)
    • architecture.md(新建一个空文件,用于记录每个文件的作用)
🎮 Vibe Coding 开发基础游戏

现在进入最爽的阶段!

确保一切清晰
  • 在 VSCode 扩展中打开 CodexClaude Code,或者在项目终端启动 Claude Code / Codex CLI。
  • 提示词:阅读 /memory-bank 里所有文档,implementation-plan.md 是否完全清晰?你有哪些问题需要我澄清,让它对你来说 100% 明确?
  • 它通常会问 9-10 个问题。全部回答完后,让它根据你的回答修改 implementation-plan.md,让计划更完善。
你的第一个实施提示词
  • 打开 CodexClaude Code(扩展或终端)。
  • 提示词:阅读 /memory-bank 所有文档,然后执行实施计划的第 1 步。我会负责跑测试。在我验证测试通过前,不要开始第 2 步。验证通过后,打开 progress.md 记录你做了什么供后续开发者参考,再把新的架构洞察添加到 architecture.md 中解释每个文件的作用。
  • 永远 先用 "Ask" 模式或 "Plan Mode"(Claude Code 中按 shift+tab),确认满意后再让 AI 执行该步骤。
  • 极致 Vibe: 安装 Superwhisper,用语音随便跟 Claude 或 gpt-5.1-codex 聊天,不用打字。
工作流
  • 完成第 1 步后:
    • 把改动提交到 Git(不会用就问 AI)。
    • 新建聊天(/new/clear)。
    • 提示词:阅读 memory-bank 所有文件,阅读 progress.md 了解之前的工作进度,然后继续实施计划第 2 步。在我验证测试前不要开始第 3 步。
  • 重复此流程,直到整个 implementation-plan.md 全部完成。
✨ 添加细节功能

恭喜!你已经做出了基础游戏!可能还很粗糙、缺少功能,但现在可以尽情实验和打磨了。

  • 想要雾效、后期处理、特效、音效?更好的飞机/汽车/城堡?绝美天空?
  • 每增加一个主要功能,就新建一个 feature-implementation.md,写短步骤+测试。
  • 继续增量式实现和测试。
🐞 修复 Bug 与卡壳情况
常规修复
  • 如果某个提示词失败或搞崩了项目:
    • Claude Code 用 /rewind 回退;用 gpt-5.1-codex 的话多提交 git,需要时 reset。
  • 报错处理:
    • JavaScript 错误: 打开浏览器控制台(F12),复制错误,贴给 AI;视觉问题截图发给它。
    • 懒人方案: 安装 BrowserTools,自动复制错误和截图。
疑难杂症
  • 实在卡住:
    • 回退到上一个 git commit(git reset),换新提示词重试。
  • 极度卡壳:
    • RepoPromptuithub 把整个代码库合成一个文件,然后丢给 gpt-5.1-codex 或 Claude 求救。
💡 技巧与窍门
Claude Code & Codex 使用技巧
  • 终端版 Claude Code / Codex CLI: 在 VSCode 终端里运行,能直接看 diff、喂上下文,不用离开工作区。
  • Claude Code 的 /rewind 迭代跑偏时一键回滚到之前状态。
  • 自定义命令: 创建像 /explain $参数 这样的快捷命令,触发提示词:“深入分析代码,彻底理解 $参数 是怎么工作的。理解完告诉我,我再给你任务。” 让模型先拉满上下文再改代码。
  • 清理上下文: 经常用 /clear/compact(保留历史对话)。
  • 省时大法(风险自负):claude --dangerously-skip-permissionscodex --yolo,彻底关闭确认弹窗。
其他实用技巧
  • 小修改: 用 gpt-5.1-codex (medium)
  • 写顶级营销文案: 用 Opus 4.1
  • 生成优秀 2D 精灵图: 用 ChatGPT + Nano Banana
  • 生成音乐: 用 Suno
  • 生成音效: 用 ElevenLabs
  • 生成视频: 用 Sora 2
  • 提升提示词效果:
    • 加一句:“慢慢想,不着急,重要的是严格按我说的做,执行完美。如果我表达不够精确请提问。”
    • 在 Claude Code 中触发深度思考的关键词强度:think < think hard < think harder < ultrathink
❓ 常见问题解答 (FAQ)
  • Q: 我在做应用不是游戏,这个流程一样吗?

    • A: 基本完全一样!把 GDD 换成 PRD(产品需求文档)即可。你也可以先用 v0、Lovable、Bolt.new 快速原型,再把代码搬到 GitHub,然后克隆到本地用本指南继续开发。
  • Q: 你那个空战游戏的飞机模型太牛了,但我一个提示词做不出来!

    • A: 那不是一个提示词,是 ~30 个提示词 + 专门的 plane-implementation.md 文件引导的。用精准指令如“在机翼上为副翼切出空间”,而不是“做一个飞机”这种模糊指令。
  • Q: 为什么现在 Claude Code 或 Codex CLI 比 Cursor 更强?

    • A: 完全看个人喜好。我们强调的是:Claude Code 能更好发挥 Claude Opus 4.5 的实力,Codex CLI 能更好发挥 gpt-5.1-codex 的实力,而 Cursor 对这两者的利用都不如原生终端版。终端版还能在任意 IDE、使用 SSH 远程服务器等场景工作,自定义命令、子代理、钩子等功能也能长期大幅提升开发质量和速度。最后,即使你只是低配 Claude 或 ChatGPT 订阅,也完全够用。
  • Q: 我不会搭建多人游戏的服务器怎么办?

    • A: 问你的 AI。

🤝 参与贡献

我们热烈欢迎各种形式的贡献!如果您对本项目有任何想法或建议,请随时开启一个 Issue 或提交一个 Pull Request

在您开始之前,请花点时间阅读我们的 贡献指南 (CONTRIBUTING.md)行为准则 (CODE_OF_CONDUCT.md)

✨ 贡献者们

感谢所有为本项目做出贡献的开发者!


📜 许可证

本项目采用 MIT 许可证。


如果这个项目对您有帮助,请不要吝啬您的 Star ⭐!

Star History

Star History Chart

Made with ❤️ and a lot of ☕ by tukuaiai,Nicolas Zulloand 123olp

⬆ 回到顶部

About

我的开发经验+vibe-coding 的中文翻译版本

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 92.7%
  • Shell 3.9%
  • Makefile 3.4%