96 lines
2.0 KiB
Markdown
96 lines
2.0 KiB
Markdown
# Aide 项目认知载入
|
||
|
||
你正在执行 Aide 项目认知载入流程。按需载入项目文档，建立对项目的认知。
|
||
|
||
## 前置准备
|
||
|
||
**首先触发 `aide` skill 学习 aide 命令的使用方法。**
|
||
|
||
---
|
||
|
||
## 开始
|
||
|
||
### 1. 检查项目文档配置
|
||
|
||
```bash
|
||
aide config get docs.path
|
||
```
|
||
|
||
### 2. 检查文档是否存在
|
||
|
||
检查配置的文档目录是否存在且包含内容。
|
||
|
||
**如果文档不存在**：
|
||
- 提示用户先执行 `/aide:docs` 创建项目文档
|
||
- 或者直接进行快速项目认知（见下文）
|
||
|
||
**如果文档存在**：
|
||
- 进入文档载入流程
|
||
|
||
---
|
||
|
||
## 文档载入流程
|
||
|
||
### 阶段 1：载入总导览
|
||
|
||
读取总导览文档（通常是 `.aide/project-docs/README.md`）：
|
||
- 了解项目简介
|
||
- 了解技术栈
|
||
- 了解架构概述
|
||
- 获取区块索引
|
||
|
||
### 阶段 2：建立脉络认知
|
||
|
||
基于总导览，建立对项目的整体认知：
|
||
- 项目的核心功能是什么
|
||
- 主要模块有哪些
|
||
- 模块之间的关系
|
||
|
||
**此时仅了解脉络，不深入细节。**
|
||
|
||
### 阶段 3：按需深入
|
||
|
||
后续根据任务需要，按需载入相关区块的详细文档：
|
||
- 任务涉及哪些模块 → 载入对应区块文档
|
||
- 需要了解某个功能 → 载入相关区块文档
|
||
|
||
---
|
||
|
||
## 快速项目认知（无文档时）
|
||
|
||
如果项目文档不存在，进行快速认知：
|
||
|
||
### 1. 阅读关键文件
|
||
|
||
按优先级阅读：
|
||
1. `README.md` - 项目说明
|
||
2. `CLAUDE.md` - Claude 指令（如存在）
|
||
3. 配置文件（`package.json`、`Cargo.toml`、`pyproject.toml` 等）
|
||
4. 入口文件（`main.py`、`index.js`、`main.rs` 等）
|
||
|
||
### 2. 探索目录结构
|
||
|
||
```bash
|
||
# 了解项目结构
|
||
ls -la
|
||
```
|
||
|
||
识别主要目录和它们的用途。
|
||
|
||
### 3. 建立初步认知
|
||
|
||
基于以上信息，建立对项目的初步认知：
|
||
- 项目类型和用途
|
||
- 主要目录结构
|
||
- 核心模块位置
|
||
|
||
---
|
||
|
||
## 完成
|
||
|
||
项目认知载入完成后：
|
||
- 已建立对项目的整体认知
|
||
- 可以根据任务需要按需深入了解细节
|
||
|
||
**注意**：此命令通常由 `/aide:run` 自动调用，不需要单独执行。
|