Vibe Coding 知识库

初始化 MD 示例集合 ​

本页把培训中 Claude Code 和 Codex 从 0 开始需要浏览、创建或维护的初始化 Markdown 文件集中起来。课堂上建议先打开本页，再逐个进入具体文件讲解。

下载资料包 ​

每个压缩包只包含一种语言，不混入另一种语言的模板。课堂建议按授课语言选择一个包，解压到空仓库后直接开始演示。

工具中文包English package
Codexcodex-md-kit-zh.zipcodex-md-kit-en.zip
Claude Codeclaude-md-kit-zh.zipclaude-md-kit-en.zip

Agent 工作协议 ​

文件面向工具用途
AGENTS.md 初始化示例Codex、通用 agent项目规则、命令、约束、完成标准、安全和 Git 协议
CLAUDE.md 初始化示例Claude CodeClaude 项目记忆、交互习惯、常用命令和长期偏好

标准化工程文档 ​

文件用途浏览入口
docs/codex/best-practices.mdCodex 使用方式、任务拆解、验证与审查规则Codex 最佳实践
docs/workflow/spec-driven.md规格驱动开发流程、需求/验收/架构模板规格驱动开发
docs/testing/test-strategy.md单元、集成、E2E 测试策略与示例自动化测试策略
docs/production/security-checklist.mdAI 生成代码上线前安全审查清单安全审查清单

课堂推荐顺序 ​

  1. 先读 规格驱动开发，明确为什么先写文档。
  2. 再读 AGENTS.md 初始化示例 和 CLAUDE.md 初始化示例，区分 Codex 与 Claude Code 的项目上下文。
  3. 然后读 Codex 最佳实践，把任务写成可验证改动。
  4. 进入 自动化测试策略，把验收标准变成测试。
  5. 最后读 安全审查清单，作为发布前 gate。

从空仓库生成文件 ​

推荐方式是下载对应工具和语言的资料包并解压，避免现场手写空文件后遗漏内容。

Windows PowerShell:

powershell
$kit = '..\codex-md-kit-zh.zip' # 可替换为 codex-md-kit-en.zip、claude-md-kit-zh.zip、claude-md-kit-en.zip
mkdir ai-delivery-board
cd ai-delivery-board
git init
Expand-Archive $kit -DestinationPath .

如果课堂必须从空文件手写，可用下面的兜底脚本。Codex 和 Claude Code 二选一创建根规则文件，不要在单工具演示中同时维护两套入口。

Codex:

bash
mkdir -p docs/project
touch AGENTS.md README.md
touch docs/project/requirements.md docs/project/acceptance.md
touch docs/project/architecture.md docs/project/design-context.md
touch docs/project/test-strategy.md docs/project/risk-register.md docs/project/release-checklist.md

Claude Code:

bash
mkdir -p docs/project
touch CLAUDE.md README.md
touch docs/project/requirements.md docs/project/acceptance.md
touch docs/project/architecture.md docs/project/design-context.md
touch docs/project/test-strategy.md docs/project/risk-register.md docs/project/release-checklist.md

Windows PowerShell 兜底写法：

powershell
New-Item -ItemType Directory -Force docs\project
New-Item -ItemType File -Force README.md
New-Item -ItemType File -Force AGENTS.md # Codex 演示；Claude Code 演示时改为 CLAUDE.md
New-Item -ItemType File -Force docs\project\requirements.md
New-Item -ItemType File -Force docs\project\acceptance.md
New-Item -ItemType File -Force docs\project\architecture.md
New-Item -ItemType File -Force docs\project\design-context.md
New-Item -ItemType File -Force docs\project\test-strategy.md
New-Item -ItemType File -Force docs\project\risk-register.md
New-Item -ItemType File -Force docs\project\release-checklist.md

Claude Code 初始化提示 ​

text
请阅读 CLAUDE.md、README.md 和 docs/project/*.md。
先不要修改文件，请输出你理解的项目目标、约束、可执行计划和验证命令。

Codex 初始化提示 ​

text
请阅读 AGENTS.md、README.md 和 docs/project/*.md。
只分析，不改文件。
请输出目标理解、风险点、计划修改文件、验证命令和分步计划。