sayurinana/agent-aide
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

✨ feat: 文档同步

Browse Source
This commit is contained in:
sayurinana(vm)
2025-12-15 18:53:39 +08:00
parent 67162d2337
commit 1329643932
16 changed files with 987 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
aide-marketplace/aide-plugin/docs/commands/exec.md → aide-marketplace/aide-plugin/docs/commands/_deprecated_exec.md
View File

0
aide-marketplace/aide-plugin/docs/commands/init.md → aide-marketplace/aide-plugin/docs/commands/_deprecated_init.md
View File

0
aide-marketplace/aide-plugin/docs/commands/prep.md → aide-marketplace/aide-plugin/docs/commands/_deprecated_prep.md
View File

185
aide-marketplace/aide-plugin/docs/commands/docs.md Normal file
View File

@@ -0,0 +1,185 @@
# /aide:docs 命令设计文档
## 一、概述
`/aide:docs` 是项目文档管理命令，用于创建和维护面向 LLM 的项目文档。
### 1.1 设计目标
| 目标 | 说明 |
|------|------|
| 独立运行 | 通常在需要时单独执行 |
| 区块化 | 文档按区块组织，支持增量更新 |
| 面向 LLM | 文档格式针对 LLM 理解优化 |
| 多对话续接 | 大项目支持多次对话完成 |
### 1.2 新增命令
本命令是 v2.0.0 新增的独立命令。
---
## 二、执行流程
### 2.1 创建流程
```
┌─────────────────────────────────────────┐
│ /aide:docs │
│ (文档不存在时) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 目录探索 │
│ (遍历结构、统计文件、识别忽略项) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 初步区块划分 │
│ (按目录结构和功能模块划分) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 区块验证 │
│ (浅层探索验证划分合理性) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 逐区块深度了解 │
│ (完整阅读、提取信息、生成文档) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 生成总导览 │
│ (整合所有区块信息) │
└─────────────────────────────────────────┘
```
### 2.2 更新流程
```
┌─────────────────────────────────────────┐
│ /aide:docs │
│ (文档已存在时) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 读取区块计划 │
│ (了解当前文档结构) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 分区块验证 │
│ (对比文档与代码，识别差异) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 增量更新 │
│ (只更新有变化的区块) │
└─────────────────────────────────────────┘
```
---
## 三、文档结构
### 3.1 目录结构
```
.aide/project-docs/
├── README.md # 总导览
├── block-plan.md # 区块计划（进度追踪）
└── blocks/ # 子区块文档
├── core.md
├── api.md
└── ...
```
### 3.2 总导览格式
```markdown
# [项目名称] 项目导览
> 本文档面向 LLM，用于快速了解项目结构和脉络。
## 项目简介
## 技术栈
## 架构概述
## 区块索引
## 快速导航
```
### 3.3 子区块格式
```markdown
# [区块名称]
> 路径：xxx/
## 概述
## 文件清单
## 核心组件
## 接口说明
## 依赖关系
## 注意事项
```
---
## 四、职责边界
### 4.1 本命令负责
- 探索项目目录结构
- 划分文档区块
- 创建和更新项目文档
- 维护区块计划（进度追踪）
### 4.2 本命令不负责
- 环境配置（由 `/aide:setup` 负责）
- 项目文档载入（由 `/aide:load` 负责）
- 任务准备和执行（由 `/aide:run` 负责）
---
## 五、区块划分规则
1. **按目录结构**：每个主要目录可作为一个区块
2. **按功能模块**：相关功能的文件归为一个区块
3. **大小控制**：单个区块不超过 5000 行代码
4. **低耦合**：区块间依赖关系尽量简单
---
## 六、多对话续接
大项目可能需要多次对话完成：
1. 每次开始时读取区块计划
2. 找到未完成的区块
3. 继续处理
4. 更新区块计划的进度
---
## 七、相关文档
- [执行文件](../../commands/docs.md)
- [/aide:load 命令](load.md)
- [plugin 导览](../README.md)
---
## 八、版本信息
- 创建日期：2025-12-15
- v2.0.0 新增命令

117
aide-marketplace/aide-plugin/docs/commands/load.md Normal file
View File

@@ -0,0 +1,117 @@
# /aide:load 命令设计文档
## 一、概述
`/aide:load` 是项目认知载入命令，用于按需载入项目文档，建立对项目的认知。
### 1.1 设计目标
| 目标 | 说明 |
|------|------|
| 按需载入 | 初次仅了解脉络，后续按需深入 |
| 节省 Token | 避免一次性加载过多信息 |
| 支持续接 | 为任务续接提供项目上下文 |
### 1.2 与旧命令的关系
本命令从原 `/aide:init` 中拆分出项目认知功能。
---
## 二、执行流程
```
┌─────────────────────────────────────────┐
│ /aide:load │
│ (通常由 /aide:run 自动调用) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 检查项目文档配置 │
│ aide config get docs.path │
└─────────────────────────────────────────┘
│
┌──────────┴──────────┐
▼ ▼
[文档存在] [文档不存在]
│ │
▼ ▼
┌───────────────┐ ┌───────────────────┐
│ 载入总导览 │ │ 提示执行 /aide:docs│
│ 建立脉络认知 │ │ 或快速项目认知 │
└───────────────┘ └───────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 按需深入 │
│ (根据任务需要载入相关区块) │
└─────────────────────────────────────────┘
```
---
## 三、职责边界
### 3.1 本命令负责
- 检查项目文档是否存在
- 载入总导览文档
- 建立项目脉络认知
- 按需载入区块详细文档
### 3.2 本命令不负责
- 环境配置（由 `/aide:setup` 负责）
- 项目文档创建和维护（由 `/aide:docs` 负责）
- 任务准备和执行（由 `/aide:run` 负责）
---
## 四、调用方式
本命令通常**不单独执行**，而是由 `/aide:run` 在以下场景自动调用：
1. 续接未完成的任务时
2. 需要了解项目上下文时
---
## 五、文档载入策略
### 5.1 初次载入（脉络认知）
仅读取总导览文档，了解：
- 项目简介
- 技术栈
- 架构概述
- 区块索引
### 5.2 按需深入
根据任务需要，载入相关区块的详细文档：
- 任务涉及哪些模块 → 载入对应区块
- 需要了解某个功能 → 载入相关区块
### 5.3 快速认知（无文档时）
如果项目文档不存在，进行快速认知：
1. 阅读 README.md、CLAUDE.md
2. 阅读配置文件（package.json、Cargo.toml 等）
3. 探索目录结构
---
## 六、相关文档
- [执行文件](../../commands/load.md)
- [/aide:docs 命令](docs.md)
- [/aide:run 命令](run.md)
- [plugin 导览](../README.md)
---
## 七、版本信息
- 创建日期：2025-12-15
- 从 `/aide:init` 拆分而来

214
aide-marketplace/aide-plugin/docs/commands/run.md Normal file
View File

@@ -0,0 +1,214 @@
# /aide:run 命令设计文档
## 一、概述
`/aide:run` 是任务执行的核心命令，整合了任务准备和任务执行功能。
### 1.1 设计目标
| 目标 | 说明 |
|------|------|
| 统一入口 | 一个命令完成任务准备和执行 |
| 状态感知 | 自动检测 flow 状态，支持续接 |
| 复杂度适应 | 支持简单任务直接执行，复杂任务拆分子计划 |
### 1.2 与旧命令的关系
本命令整合了原 `/aide:prep` 和 `/aide:exec` 的功能。
---
## 二、执行流程
### 2.1 总体流程
```
┌─────────────────────────────────────────┐
│ /aide:run │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 强制触发 aide skill │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ aide flow status │
│ (检查当前 flow 状态) │
└─────────────────────────────────────────┘
│
┌──────────┴──────────┐
▼ ▼
[无活跃任务] [有活跃任务]
[或已 finish] [未完成]
│ │
▼ ▼
新任务流程 续接流程
```
### 2.2 新任务流程
```
┌─────────────────────────────────────────┐
│ task-optimize (任务准备) │
├─────────────────────────────────────────┤
│ 1. aide flow start task-optimize │
│ 2. 读取任务文档 │
│ 3. 任务分析 │
│ 4. 复杂度评估 │
│ 5. 任务优化 │
│ 6. 待定项处理（如有） │
│ 7. 生成任务细则 │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ flow-design (流程设计) │
├─────────────────────────────────────────┤
│ 1. aide flow next-part flow-design │
│ 2. 制定执行计划 │
│ 3. 创建流程图（PlantUML） │
│ 4. aide flow next-part impl │
│ (自动校验并生成 PNG) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ impl (迭代实现) │
├─────────────────────────────────────────┤
│ 按计划执行，每步记录： │
│ aide flow next-step "<完成内容>" │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ verify (验证交付) │
├─────────────────────────────────────────┤
│ 1. aide flow next-part verify │
│ 2. 对照任务细则验证 │
│ 3. 执行测试（如适用） │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ docs (文档更新) │
├─────────────────────────────────────────┤
│ 1. aide flow next-part docs │
│ 2. 更新 README、CHANGELOG 等 │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ finish (收尾) │
├─────────────────────────────────────────┤
│ 1. aide flow next-part finish │
│ 2. 清理临时文件 │
│ 3. 向用户汇报 │
└─────────────────────────────────────────┘
```
### 2.3 续接流程
```
┌─────────────────────────────────────────┐
│ 分析当前进度 │
├─────────────────────────────────────────┤
│ aide flow status │
│ aide flow show <task_id> │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 载入项目认知 │
├─────────────────────────────────────────┤
│ 调用 /aide:load 逻辑 │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 读取任务细则 │
├─────────────────────────────────────────┤
│ aide config get task.spec │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 从中断处继续执行 │
└─────────────────────────────────────────┘
```
---
## 三、复杂任务处理
### 3.1 复杂度评估
根据**任务复杂度评估指导原则**判断：
| 等级 | 特征 | 处理方式 |
|------|------|----------|
| 简单 | 单文件或少量文件 | 直接执行 |
| 中等 | 2-4 个模块 | 直接执行 |
| 复杂 | 5+ 模块 | **拆分子计划** |
| 超大 | 10+ 模块 | 拆分独立任务 |
### 3.2 子计划执行模式
```
task-optimize
│
▼
[flow-design → impl → verify → docs] × N
│
▼
finish
```
每个子计划完成 docs 后，回退到 flow-design 开始下一个子计划。
---
## 四、职责边界
### 4.1 本命令负责
- 检查 flow 状态
- 任务分析和优化
- 复杂度评估和子计划拆分
- 待定项处理
- 流程设计和流程图创建
- 迭代实现
- 验证交付
- 文档更新
- 收尾汇报
### 4.2 本命令不负责
- 环境配置（由 `/aide:setup` 负责）
- 项目文档创建和维护（由 `/aide:docs` 负责）
---
## 五、触发的 Skill
| Skill | 触发方式 | 用途 |
|-------|----------|------|
| aide | 强制触发 | 提供 aide 命令使用指南 |
---
## 六、相关文档
- [执行文件](../../commands/run.md)
- [aide skill](../../skills/aide/SKILL.md)
- [aide flow 子命令](../../../../aide-program/docs/commands/flow.md)
- [aide decide 子命令](../../../../aide-program/docs/commands/decide.md)
- [plugin 导览](../README.md)
---
## 七、版本信息
- 创建日期：2025-12-15
- 整合原 `/aide:prep` 和 `/aide:exec`

140
aide-marketplace/aide-plugin/docs/commands/setup.md Normal file
View File

@@ -0,0 +1,140 @@
# /aide:setup 命令设计文档
## 一、概述
`/aide:setup` 是环境配置命令，专注于环境依赖分析、配置、检测和修复。
### 1.1 设计目标
| 目标 | 说明 |
|------|------|
| 独立运行 | 通常在新项目开始时单独执行 |
| 环境专注 | 只处理环境问题，不涉及任务执行 |
| 自动化 | 尽可能自动检测和修复环境问题 |
### 1.2 与旧命令的关系
本命令从原 `/aide:init` 中拆分出环境相关功能。
---
## 二、执行流程
```
┌─────────────────────────────────────────┐
│ /aide:setup │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 强制触发 env-config skill │
│ (获取详细环境配置指导) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ aide env ensure --runtime │
│ (检查 aide 运行时环境) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ aide init │
│ (初始化 .aide 目录) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 分析项目依赖 │
│ (识别项目类型和所需模块) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ aide env set modules ... │
│ (配置环境模块) │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ aide env ensure │
│ (执行环境检测) │
└─────────────────────────────────────────┘
│
┌──────────┴──────────┐
▼ ▼
[成功] [失败]
│ │
▼ ▼
完成汇报 故障排除
│
▼
重试(最多3次)
```
---
## 三、职责边界
### 3.1 本命令负责
- 检测 aide 运行时环境
- 初始化 .aide 目录
- 分析项目类型和依赖
- 配置环境检测模块
- 执行环境检测和修复
- 处理环境问题
### 3.2 本命令不负责
- 项目认知和文档载入（由 `/aide:load` 负责）
- 任务准备和执行（由 `/aide:run` 负责）
- 项目文档管理（由 `/aide:docs` 负责）
---
## 四、触发的 Skill
| Skill | 触发方式 | 用途 |
|-------|----------|------|
| env-config | 强制触发 | 提供详细的环境配置和故障排除指导 |
---
## 五、使用场景
### 5.1 新项目开始
```bash
# 用户执行
/aide:setup
# LLM 执行流程
1. 触发 env-config skill
2. aide env ensure --runtime
3. aide init
4. 分析项目（检查 package.json、Cargo.toml 等）
5. aide env set modules <根据项目类型>
6. aide env ensure
7. 汇报结果
```
### 5.2 环境问题排查
当任务执行中遇到环境错误时，用户可重新执行此命令进行诊断和修复。
---
## 六、相关文档
- [执行文件](../../commands/setup.md)
- [env-config skill](../../skills/env-config/SKILL.md)
- [aide env 子命令](../../../../aide-program/docs/commands/env.md)
- [plugin 导览](../README.md)
---
## 七、版本信息
- 创建日期：2025-12-15
- 从 `/aide:init` 拆分而来