AI-Context-Android-template

将以下模板内容保存为项目根目录的 AIContext.md，填入实际信息后，即可作为 AI Agent 的上下文索引。

提示：配合 risk-scan-3mo skill（放到 ~/.claude/skills/ 下）使用效果更佳，可替代 git log / git diff 避免大仓库卡顿。

---

Android 专项模板

适用于 Android / AAOS 项目，针对 Android 特有的类型（Activity、Fragment、Manager 等）提供了专项搜索示例。

# {{项目名}} 代码索引指南

> 本文档为 AI Agent 提供快速索引和查找代码功能的上下文指南

## 📋 目录

- [代码搜索规则](#代码搜索规则)
- [整体架构](#整体架构)
- [模块索引](#模块索引)
- [常见功能查找指南](#常见功能查找指南)
- [关键技术栈](#关键技术栈)

---

## 🔍 代码搜索规则

### 禁止操作

<!-- 根据项目实际情况填写，例如大仓库禁止根目录 Grep -->

- 禁止在根目录使用 Grep（大型项目会超时）
- 禁止直接执行 `git log / git diff`（大仓库会卡顿，改用 risk-scan-3mo SKILL）

### 推荐搜索策略

#### 搜索优先级顺序

1. **先查本 AIContext.md 索引** - 快速定位模块位置
2. **精确 Glob** - 文件名或类名已知时
3. **限定路径 Grep** - 在具体模块内搜索关键字
4. **Read 具体文件** - 已知文件路径时直接读取

#### 分层搜索策略

\`\`\`
第一层: 确定功能所属大模块（查本文档）
第二层: 在模块内 Glob/Grep 搜索具体文件
第三层: Read 目标文件
\`\`\`

---

## 🏗️ 整体架构

### 项目结构

\`\`\`
{{项目名}}/
├── {{模块1}}/          # {{模块1 一句话说明}}
├── {{模块2}}/          # {{模块2 一句话说明}}
├── {{模块3}}/          # {{模块3 一句话说明}}
└── build.gradle        # 构建配置
\`\`\`

### 分层架构

\`\`\`
┌──────────────────────────────────┐
│  {{最上层模块名}} ({{目录名}}/)  │
│  {{职责描述}}                    │
├──────────────────────────────────┤
│  {{中间层模块名}} ({{目录名}}/)  │
│  {{职责描述}}                    │
├──────────────────────────────────┤
│  {{基础层模块名}} ({{目录名}}/)  │
│  {{职责描述}}                    │
└──────────────────────────────────┘
\`\`\`

---

## 🎯 模块索引

### 1. {{模块名}}

- **路径**: `{{模块根路径}}/`
- **包名**: `{{包名}}`（如有）
- **职责**: {{一句话描述职责}}

#### 核心类

| 类名            | 路径（相对模块根） | 说明     |
| --------------- | ------------------ | -------- |
| `{{ClassName}}` | `{{相对路径}}`     | {{说明}} |

#### {{子功能名}}（{{子目录名}}/）

- **路径**: `{{子目录路径}}/`
- **功能**: {{功能描述}}
- **核心类**:
  - `{{ClassName}}` - {{说明}}

**搜索示例**:

\`\`\`bash
# 查找 {{功能关键词}} 相关
Glob: pattern="{{模块路径}}/**/*{{关键词}}*.{java,kt}"

# 在模块内搜索关键字
Grep: pattern="{{关键词}}", path="{{模块路径}}", glob="**/*.{java,kt}"
\`\`\`

---

<!-- 按需复制以上"### N. 模块名"块 -->

---

## 🔎 常见功能查找指南

### 按功能快速定位

| 功能描述      | 搜索路径   | 关键类/文件 |
| ------------- | ---------- | ----------- |
| **{{功能1}}** | `{{路径}}` | `{{类名}}`  |
| **{{功能2}}** | `{{路径}}` | `{{类名}}`  |

### 按文件类型查找

\`\`\`bash
# 查找 Activity
Glob: pattern="**/activity/**/*Activity*.{java,kt}"

# 查找 Fragment
Glob: pattern="**/fragment/**/*Fragment*.{java,kt}"

# 查找 Controller/Manager
Glob: pattern="**/*Controller*.{java,kt}"
Glob: pattern="**/*Manager*.{java,kt}"

# 查找数据模型
Glob: pattern="**/model/**/*.{java,kt}"
\`\`\`

---

## 🔧 关键技术栈

### 架构模式

- {{架构模式，如 MVVM / MVC / 分层架构}}

### 编程语言

- **Kotlin** - {{使用范围}}
- **Java** - {{使用范围}}

### UI 框架

- {{如 Android View / Jetpack Compose / Preference}}

### 数据持久化

- {{如 Room / SharedPreferences / DataStore}}

### 关键系统集成

- {{如 ContentProvider / Binder / BroadcastReceiver}}

### 构建工具

- {{如 Gradle / Android.bp}}

---

## 🎯 快速查找清单

开始查找功能前，问自己这些问题：

1. **{{问题1，如：是 UI 界面还是后台逻辑？}}**
   - {{选项A}} → 查 `{{路径A}}`
   - {{选项B}} → 查 `{{路径B}}`

2. **{{问题2}}**
   - 是 → 查 `{{路径}}`

3. **有没有关键词？**
   - 有 → 在对应模块路径下用 Grep 搜索

---

## 📝 更新日志

- **{{YYYY-MM-DD}}**: 初始版本创建

---

通用模板

适用于任意语言 / 框架的项目，架构图提供垂直分层、水平模块、树形依赖三种可选样式，按需选用。

# {{项目名}} 代码索引指南

> 本文档为 AI Agent 提供快速索引和查找代码功能的上下文指南

## 📋 目录

- [代码搜索规则](#代码搜索规则)
- [整体架构](#整体架构)
- [模块索引](#模块索引)
- [常见功能查找指南](#常见功能查找指南)
- [关键技术栈](#关键技术栈)

---

## 🔍 代码搜索规则

### 禁止操作

<!-- 按需选填，删除不适用的 -->

- 禁止在根目录使用 Grep（大型项目会超时）
- 禁止直接执行 `git log / git diff`（大仓库会卡顿，改用 risk-scan-3mo SKILL）

### 搜索优先级

1. 先查本文档索引 → 定位模块路径
2. Glob（已知文件名/类名）
3. 限定路径的 Grep（在模块内搜关键字）
4. Read（已知路径时直接读）

---

## 🏗️ 整体架构

### 项目结构

\`\`\`
{{项目名}}/
├── {{目录1}}/      # {{一句话说明}}
├── {{目录2}}/      # {{一句话说明}}
├── {{目录3}}/      # {{一句话说明}}
└── {{配置文件}}    # {{说明}}
\`\`\`

### 分层架构

<!--
按实际情况选用一种图示，删除其余两种
-->

<!-- 方式A：垂直分层（适合后端/系统级项目） -->

\`\`\`
┌─────────────────────────┐
│  表现层 / UI 层          │  {{目录路径}}
├─────────────────────────┤
│  业务逻辑层              │  {{目录路径}}
├─────────────────────────┤
│  数据访问层              │  {{目录路径}}
├─────────────────────────┤
│  基础设施层              │  {{目录路径}}
└─────────────────────────┘
\`\`\`

<!-- 方式B：水平模块分割（适合前端/微服务） -->

\`\`\`
┌──────────┬──────────┬──────────┐
│ 模块 A   │ 模块 B   │ 模块 C   │
│ {{说明}} │ {{说明}} │ {{说明}} │
└──────────┴──────────┴──────────┘
         共享基础层 (common/shared)
\`\`\`

<!-- 方式C：树形依赖（适合 monorepo / 插件体系） -->

\`\`\`
{{顶层模块}}
├── {{子模块1}}（依赖 common）
├── {{子模块2}}（依赖 common）
└── common（无依赖）
\`\`\`

---

## 🎯 模块索引

<!--
每个模块复制一份下面的块，按需增减子节
-->

### 1. {{模块名}}

- **路径**: `{{路径}}/`
- **职责**: {{一句话}}
- **入口文件**: `{{文件路径}}`（可选）

#### 核心文件 / 类

| 文件/类名  | 路径           | 说明     |
| ---------- | -------------- | -------- |
| `{{名称}}` | `{{相对路径}}` | {{说明}} |

#### 子目录说明

| 目录          | 说明     |
| ------------- | -------- |
| `{{子目录}}/` | {{说明}} |

**搜索示例**:

\`\`\`bash
Glob: pattern="{{模块路径}}/**/*{{关键词}}*"
Grep: pattern="{{关键词}}", path="{{模块路径}}"
\`\`\`

---

## 🔎 常见功能查找指南

### 按功能快速定位

| 功能描述      | 路径       | 关键文件/类  |
| ------------- | ---------- | ------------ |
| **{{功能1}}** | `{{路径}}` | `{{文件名}}` |
| **{{功能2}}** | `{{路径}}` | `{{文件名}}` |

### 按文件角色查找

\`\`\`bash
# 入口 / 路由
Glob: pattern="**/{{router|routes|index|main}}*"

# 配置文件
Glob: pattern="**/*.{config,conf,yaml,toml,json}"

# 测试文件
Glob: pattern="**/*.{test,spec}.{js,ts,py,go,java,kt}"

# 接口 / 协议定义
Glob: pattern="**/{interface,proto,schema,types}/**/*"
\`\`\`

---

## 🔧 关键技术栈

### 语言 & 运行时

- **主语言**: {{语言 + 版本}}
- **运行时**: {{如 Node.js 18 / JVM 17 / Python 3.11}}

### 框架 & 核心库

- **{{功能域}}**: {{框架名}}（{{版本/说明}}）

### 数据存储

- **{{存储类型}}**: {{技术名}}（{{用途}}）

### 构建 & 包管理

- **构建工具**: {{如 Gradle / Maven / npm / cargo / go mod}}
- **包管理**: {{如 npm / pip / pub / bundler}}

### 外部依赖 & 集成

- **{{集成点}}**: {{说明}}

---

## 🎯 快速查找清单

开始前问自己：

1. **这是哪个功能域？**（对照模块索引定位路径）
2. **是新增逻辑还是修改现有行为？**
   - 新增 → 找同类文件参考
   - 修改 → 找调用链入口
3. **有无关键词？** → 在对应模块路径下 Grep
4. **有无相似功能？** → 找同目录下同名模式文件参考

---

## 📝 更新日志

- **{{YYYY-MM-DD}}**: 初始版本创建