Skip to content

ai-context-template.md

Latest commit

 

History

History
72 lines (45 loc) · 1.8 KB

ai-context-template.md

File metadata and controls

72 lines (45 loc) · 1.8 KB

AI-CONTEXT.md 模板

放在项目根目录，所有 agent 收到任务后第一件事就是读这个文件。 Leader 在 agent-apply 开始前检查：不存在则从 CLAUDE.md 自动生成。

# AI Context

## 项目简介

<!-- 一两句话说明这个项目是什么、做什么 -->

## 技术栈

<!-- 语言、框架、关键依赖 -->

## 目录结构

<!-- 核心目录说明 -->

project/
├── src/          ← 源码
├── tests/        ← 测试
└── ...

## 架构概要

<!-- 核心模块关系，可用 ASCII 图 -->

## 约定

<!-- 命名、代码风格、测试方式等 -->

## 注意事项

<!-- 踩过的坑、不能动的东西、特殊限制 -->

使用说明

手动创建

把上面的模板复制到项目根目录，填入实际内容。

自动生成

如果项目已有 CLAUDE.md（Claude Code 自动生成的项目描述），Leader 会在 agent-apply 开始前自动从中提取信息生成 AI-CONTEXT.md。提取的字段：

  1. 项目简介 — 项目是什么、做什么
  2. 技术栈 — 语言、框架、依赖
  3. 目录结构 — 核心目录
  4. 架构概要 — 模块关系
  5. 约定 — 命名、风格、测试约定
  6. 注意事项 — 踩坑记录、限制

三种情况

情况 Leader 行为
项目有 AI-CONTEXT.md 跳过，直接开始
没有 AI-CONTEXT.md，有 CLAUDE.md 从 CLAUDE.md 自动生成
两者都没有 提醒用户手动创建

为什么需要这个文件？

  • 统一上下文：所有 agent 读同一份背景信息，减少因信息缺失产生的幻觉
  • 与 CLAUDE.md 分离：CLAUDE.md 是 Claude Code 专属配置，AI-CONTEXT.md 是跨平台共享的项目背景
  • 轻量：一个 markdown 文件，不依赖任何工具