93d1b21的任务收尾
This commit is contained in:
251
aide-marketplace/aide-plugin/commands/readme.md
Normal file
251
aide-marketplace/aide-plugin/commands/readme.md
Normal file
@@ -0,0 +1,251 @@
|
||||
# Aide README 生成
|
||||
|
||||
你正在执行 Aide README 生成流程。这个命令帮助用户创建和维护项目 README 文件。
|
||||
|
||||
---
|
||||
|
||||
## 前置准备
|
||||
|
||||
**首先触发 `readme-templates` skill 学习模板使用方法。**
|
||||
|
||||
---
|
||||
|
||||
## 开始
|
||||
|
||||
### 检查规范文件
|
||||
|
||||
```bash
|
||||
aide config get user_docs.rules_path
|
||||
```
|
||||
|
||||
读取配置的规范文件路径，检查文件是否存在。
|
||||
|
||||
**根据规范文件状态决定流程**：
|
||||
|
||||
- **规范文件不存在** → 进入**规范引导流程**
|
||||
- **规范文件存在** → 进入**README 生成流程**
|
||||
|
||||
---
|
||||
|
||||
## 规范引导流程
|
||||
|
||||
当 `make-readme-rules.md` 不存在时执行此流程。
|
||||
|
||||
### 1. 提示用户
|
||||
|
||||
向用户说明：
|
||||
|
||||
> 检测到项目尚未创建 README 编写规范（`make-readme-rules.md`）。
|
||||
>
|
||||
> **建议**：
|
||||
> - 如果尚未创建面向 LLM 的项目文档（`.aide/project-docs/`），建议先执行 `/aide:docs` 和 `/aide:load`
|
||||
> - 项目文档可以帮助我更好地理解项目，从而提供更准确的 README 建议
|
||||
>
|
||||
> 规范制定是一个重要任务，建议在本次对话中专注完成。完成后可使用 `/exit` 退出。
|
||||
|
||||
### 2. 询问用户
|
||||
|
||||
使用 AskUserQuestion 询问：
|
||||
|
||||
> 是否继续创建 README 编写规范？
|
||||
|
||||
**选项**：
|
||||
- **继续创建**（推荐）
|
||||
- **先执行 /aide:docs**（如果项目文档不存在）
|
||||
|
||||
### 3. 分析项目
|
||||
|
||||
如用户选择继续：
|
||||
|
||||
#### 3.1 检查项目文档
|
||||
|
||||
```bash
|
||||
aide config get docs.path
|
||||
```
|
||||
|
||||
如果项目文档目录存在，阅读总导览（`README.md`），了解：
|
||||
- 项目类型
|
||||
- 技术栈
|
||||
- 主要功能
|
||||
- 模块结构
|
||||
|
||||
#### 3.2 分析项目代码（如无项目文档）
|
||||
|
||||
如果没有项目文档，快速浏览：
|
||||
- `README.md`（如存在）
|
||||
- `package.json` / `Cargo.toml` / `pyproject.toml` 等配置文件
|
||||
- 入口文件
|
||||
- 目录结构
|
||||
|
||||
### 4. 推荐模板
|
||||
|
||||
基于项目分析，向用户推荐：
|
||||
|
||||
#### 4.1 基础模板推荐
|
||||
|
||||
根据项目类型推荐一个基础模板：
|
||||
|
||||
| 项目类型 | 推荐模板 |
|
||||
|----------|----------|
|
||||
| 小脚本/工具 | `minimal` |
|
||||
| npm/pip/cargo 库 | `library` |
|
||||
| CLI/GUI/Web 应用 | `application` |
|
||||
| 文档/教程 | `documentation` |
|
||||
| 多项目仓库 | `monorepo` |
|
||||
|
||||
说明推荐理由。
|
||||
|
||||
#### 4.2 可选模块推荐
|
||||
|
||||
基于项目特点，推荐启用的模块：
|
||||
|
||||
| 模块 | 推荐场景 |
|
||||
|------|----------|
|
||||
| `quickstart` | 用户需要快速上手 |
|
||||
| `installation` | 有多种安装方式 |
|
||||
| `examples` | API/工具类项目 |
|
||||
| `api` | 库/SDK 项目 |
|
||||
| `configuration` | 有配置文件 |
|
||||
| `architecture` | 复杂系统 |
|
||||
| `contributing` | 开源项目 |
|
||||
| `changelog` | 需要版本追踪 |
|
||||
| `license` | 公开项目 |
|
||||
| `faq` | 预期有常见问题 |
|
||||
|
||||
### 5. 用户确认
|
||||
|
||||
使用 AskUserQuestion 确认：
|
||||
|
||||
- 基础模板选择
|
||||
- 启用的模块列表
|
||||
- 其他自定义要求
|
||||
|
||||
### 6. 生成规范文件
|
||||
|
||||
根据用户选择生成 `make-readme-rules.md`：
|
||||
|
||||
```markdown
|
||||
# README 编写规范
|
||||
|
||||
## 基础模板
|
||||
|
||||
模板：{{TEMPLATE_NAME}}
|
||||
|
||||
## 启用模块
|
||||
|
||||
{{ENABLED_MODULES_LIST}}
|
||||
|
||||
## 自定义要求
|
||||
|
||||
{{CUSTOM_REQUIREMENTS}}
|
||||
|
||||
## 生成时间
|
||||
|
||||
{{TIMESTAMP}}
|
||||
```
|
||||
|
||||
### 7. 询问是否立即生成
|
||||
|
||||
> 规范文件已创建。是否立即生成 README？
|
||||
|
||||
**选项**：
|
||||
- **立即生成**（推荐）
|
||||
- **稍后生成**
|
||||
|
||||
如选择立即生成，进入 README 生成流程。
|
||||
|
||||
---
|
||||
|
||||
## README 生成流程
|
||||
|
||||
当 `make-readme-rules.md` 存在时执行此流程。
|
||||
|
||||
### 1. 读取规范文件
|
||||
|
||||
读取 `make-readme-rules.md`，获取：
|
||||
- 选择的基础模板
|
||||
- 启用的模块列表
|
||||
- 自定义要求
|
||||
|
||||
### 2. 加载项目信息
|
||||
|
||||
#### 2.1 项目文档（优先）
|
||||
|
||||
如果存在 `.aide/project-docs/`，读取总导览获取：
|
||||
- 项目名称和描述
|
||||
- 技术栈信息
|
||||
- 功能特性
|
||||
- 架构概述
|
||||
|
||||
#### 2.2 代码分析（补充）
|
||||
|
||||
补充分析：
|
||||
- 安装方式（从配置文件推断）
|
||||
- 使用示例（从测试或文档提取）
|
||||
- API 文档（从代码注释提取）
|
||||
|
||||
### 3. 读取模板
|
||||
|
||||
根据规范文件中的模板选择，读取对应的模板文件：
|
||||
|
||||
```
|
||||
aide-marketplace/aide-plugin/skills/readme-templates/templates/{template}.md
|
||||
```
|
||||
|
||||
### 4. 读取模块
|
||||
|
||||
读取启用的模块文件：
|
||||
|
||||
```
|
||||
aide-marketplace/aide-plugin/skills/readme-templates/modules/module-{name}.md
|
||||
```
|
||||
|
||||
### 5. 生成 README
|
||||
|
||||
结合模板、模块和项目信息：
|
||||
1. 以基础模板为框架
|
||||
2. 在适当位置插入模块内容
|
||||
3. 填充所有占位符
|
||||
4. 应用自定义要求
|
||||
|
||||
### 6. 检查现有 README
|
||||
|
||||
```bash
|
||||
aide config get user_docs.readme_path
|
||||
```
|
||||
|
||||
- 如果 README 已存在，直接覆盖（无需备份，git 提供版本控制）
|
||||
- 如果不存在，创建新文件
|
||||
|
||||
### 7. 写入 README
|
||||
|
||||
将生成的内容写入 `README.md`（或配置的路径）。
|
||||
|
||||
### 8. 完成提示
|
||||
|
||||
> README 已生成：`README.md`
|
||||
>
|
||||
> 建议：
|
||||
> - 检查生成的内容是否准确
|
||||
> - 补充具体的代码示例
|
||||
> - 更新任何过时的信息
|
||||
>
|
||||
> 如需调整规范，可编辑 `make-readme-rules.md` 后重新运行 `/aide:readme`。
|
||||
|
||||
---
|
||||
|
||||
## 配置项
|
||||
|
||||
| 配置项 | 默认值 | 说明 |
|
||||
|--------|--------|------|
|
||||
| `user_docs.readme_path` | `README.md` | README 文件路径 |
|
||||
| `user_docs.rules_path` | `make-readme-rules.md` | 编写规范文件路径 |
|
||||
|
||||
---
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. **规范文件的重要性**：规范文件确保每次生成的 README 风格一致
|
||||
2. **项目文档的价值**：有项目文档时，生成的 README 质量更高
|
||||
3. **迭代改进**：可以多次运行命令，逐步完善 README
|
||||
4. **版本控制**：README 的历史版本由 git 管理，无需额外备份
|
||||
@@ -386,38 +386,7 @@ aide flow next-part confirm "文档更新完成，进入用户确认环节"
|
||||
|
||||
当用户发现问题或有新需求时：
|
||||
|
||||
##### 分析问题类型
|
||||
|
||||
| 问题类型 | 返工阶段 | 说明 |
|
||||
|----------|----------|------|
|
||||
| 实现问题 | impl | 代码逻辑错误、功能不符预期 |
|
||||
| 设计问题 | flow-design | 架构或流程设计有误 |
|
||||
| 需求问题 | task-optimize | 需求理解偏差、新增需求 |
|
||||
|
||||
##### 返工前必须操作
|
||||
|
||||
**必须**在返工前完成以下操作：
|
||||
|
||||
1. **更新任务文档（task.source）**：
|
||||
- 记录用户反馈的问题
|
||||
- 补充新发现的需求或要求
|
||||
- 这是为了便于上下文中断后恢复
|
||||
|
||||
2. **更新任务计划文档**：
|
||||
- 简单任务：更新 `task.spec`
|
||||
- 复杂任务：更新相应的子计划文档（`spec-NN.md`）
|
||||
|
||||
```bash
|
||||
aide flow next-step "更新任务文档，准备返工"
|
||||
```
|
||||
|
||||
##### 执行返工
|
||||
|
||||
```bash
|
||||
aide flow back-part <目标阶段> "返工原因: <简述>"
|
||||
```
|
||||
|
||||
从目标阶段继续执行，直到再次到达 confirm 阶段。
|
||||
**触发 rework skill**：加载 `rework` skill 学习返工流程指南，按照指南完成返工处理。
|
||||
|
||||
### 阶段 7：收尾 (finish)
|
||||
|
||||
|
||||
270
aide-marketplace/aide-plugin/commands/user-docs.md
Normal file
270
aide-marketplace/aide-plugin/commands/user-docs.md
Normal file
@@ -0,0 +1,270 @@
|
||||
# Aide 用户文档生成
|
||||
|
||||
你正在执行 Aide 用户文档生成流程。这个命令帮助用户在 docs 目录下创建面向用户的详细文档。
|
||||
|
||||
---
|
||||
|
||||
## 前置准备
|
||||
|
||||
**首先触发 `readme-templates` skill 学习模板使用方法。**
|
||||
|
||||
---
|
||||
|
||||
## 开始
|
||||
|
||||
### 1. 检查前置条件
|
||||
|
||||
#### 1.1 检查 README 规范文件
|
||||
|
||||
```bash
|
||||
aide config get user_docs.rules_path
|
||||
```
|
||||
|
||||
如果规范文件不存在：
|
||||
|
||||
> 检测到 README 编写规范（`make-readme-rules.md`）不存在。
|
||||
>
|
||||
> 建议先执行 `/aide:readme` 创建规范文件。规范文件定义了项目的文档风格，
|
||||
> 用户文档应与 README 保持一致的风格。
|
||||
|
||||
使用 AskUserQuestion 询问：
|
||||
- **先执行 /aide:readme**（推荐）
|
||||
- **继续生成文档**（使用默认风格）
|
||||
|
||||
#### 1.2 检查项目文档
|
||||
|
||||
```bash
|
||||
aide config get docs.path
|
||||
```
|
||||
|
||||
如果项目文档目录（`.aide/project-docs/`）不存在：
|
||||
|
||||
> 检测到面向 LLM 的项目文档（`.aide/project-docs/`）不存在。
|
||||
>
|
||||
> 建议先执行 `/aide:docs` 和 `/aide:load` 创建项目文档。
|
||||
> 项目文档可以帮助生成更准确、更完整的用户文档。
|
||||
|
||||
使用 AskUserQuestion 询问：
|
||||
- **先执行 /aide:docs**（推荐）
|
||||
- **继续生成文档**（基于代码分析）
|
||||
|
||||
---
|
||||
|
||||
## 2. 分析项目
|
||||
|
||||
### 2.1 读取项目信息
|
||||
|
||||
**优先级**：
|
||||
|
||||
1. **项目文档**（如果存在）：
|
||||
- 读取 `.aide/project-docs/README.md` 获取项目概述
|
||||
- 阅读相关区块文档了解详细信息
|
||||
|
||||
2. **README**（如果存在）：
|
||||
- 读取 README.md 了解项目定位
|
||||
|
||||
3. **代码分析**：
|
||||
- 分析配置文件（package.json、Cargo.toml、pyproject.toml 等）
|
||||
- 分析目录结构
|
||||
- 识别主要功能模块
|
||||
|
||||
### 2.2 确定项目类型
|
||||
|
||||
| 类型 | 特征 |
|
||||
|------|------|
|
||||
| 纯文档/材料 | 主要是 markdown 文件，无代码 |
|
||||
| 单体程序 | 单一主项目，可能有子模块 |
|
||||
| 多项目仓库 | 包含多个独立子项目 |
|
||||
|
||||
---
|
||||
|
||||
## 3. 规划文档结构
|
||||
|
||||
### 3.1 纯文档/材料类项目
|
||||
|
||||
```
|
||||
docs/
|
||||
├── overview.md # 内容概述
|
||||
├── navigation.md # 导航指南
|
||||
└── topics/ # 主题分类
|
||||
├── topic-1.md
|
||||
└── topic-2.md
|
||||
```
|
||||
|
||||
### 3.2 单体程序项目
|
||||
|
||||
```
|
||||
docs/
|
||||
├── getting-started.md # 快速开始
|
||||
├── installation.md # 安装指南
|
||||
├── usage.md # 使用说明
|
||||
├── configuration.md # 配置说明（如有配置）
|
||||
├── api/ # API 文档（如有）
|
||||
│ ├── index.md
|
||||
│ └── ...
|
||||
└── guides/ # 使用指南
|
||||
└── ...
|
||||
```
|
||||
|
||||
### 3.3 多项目仓库
|
||||
|
||||
```
|
||||
docs/
|
||||
├── overview.md # 仓库概述
|
||||
├── projects/ # 各项目文档
|
||||
│ ├── project-a/
|
||||
│ │ ├── README.md
|
||||
│ │ └── ...
|
||||
│ └── project-b/
|
||||
│ ├── README.md
|
||||
│ └── ...
|
||||
└── shared/ # 共享文档
|
||||
└── ...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. 向用户确认结构
|
||||
|
||||
向用户展示规划的文档结构，使用 AskUserQuestion 确认：
|
||||
|
||||
> 根据项目分析，建议创建以下文档结构：
|
||||
>
|
||||
> ```
|
||||
> {{PLANNED_STRUCTURE}}
|
||||
> ```
|
||||
>
|
||||
> 是否按此结构生成文档？
|
||||
|
||||
**选项**：
|
||||
- **确认生成**（推荐）
|
||||
- **调整结构**（自定义）
|
||||
|
||||
如用户选择调整，通过对话确认最终结构。
|
||||
|
||||
---
|
||||
|
||||
## 5. 生成文档
|
||||
|
||||
### 5.1 检查现有文档
|
||||
|
||||
```bash
|
||||
aide config get user_docs.docs_path
|
||||
```
|
||||
|
||||
检查 docs 目录是否存在以及包含的内容。
|
||||
|
||||
### 5.2 处理现有内容
|
||||
|
||||
**首次生成**：直接创建所有文档
|
||||
|
||||
**增量更新**（docs 目录已存在）：
|
||||
|
||||
对于每个文档文件：
|
||||
|
||||
1. **新文件**：直接创建
|
||||
2. **已存在的文件**：
|
||||
- 检查是否有 `<!-- USER-EDIT: DO NOT MODIFY ABOVE -->` 标记
|
||||
- 保留标记以上的用户编辑内容
|
||||
- 更新标记以下的自动生成内容
|
||||
|
||||
### 5.3 文档内容规范
|
||||
|
||||
每个文档文件应包含：
|
||||
|
||||
```markdown
|
||||
# 文档标题
|
||||
|
||||
<!-- AUTO-GENERATED: This section is automatically maintained -->
|
||||
|
||||
{{自动生成内容}}
|
||||
|
||||
<!-- USER-EDIT: DO NOT MODIFY ABOVE -->
|
||||
<!-- You can add custom content below -->
|
||||
|
||||
{{用户自定义内容区域}}
|
||||
```
|
||||
|
||||
### 5.4 生成各文档
|
||||
|
||||
#### getting-started.md（快速开始）
|
||||
|
||||
- 最小可运行示例
|
||||
- 简洁的步骤说明
|
||||
- 链接到详细文档
|
||||
|
||||
#### installation.md（安装指南）
|
||||
|
||||
- 系统要求
|
||||
- 多种安装方式
|
||||
- 安装验证步骤
|
||||
- 常见问题
|
||||
|
||||
#### usage.md（使用说明）
|
||||
|
||||
- 基本用法
|
||||
- 常用命令/操作
|
||||
- 参数说明
|
||||
|
||||
#### configuration.md（配置说明）
|
||||
|
||||
- 配置文件位置
|
||||
- 配置项详解
|
||||
- 配置示例
|
||||
|
||||
#### api/（API 文档）
|
||||
|
||||
- 按模块组织
|
||||
- 函数签名
|
||||
- 参数说明
|
||||
- 使用示例
|
||||
|
||||
---
|
||||
|
||||
## 6. 更新 README
|
||||
|
||||
如果 README 中有文档链接部分，更新链接指向新生成的文档：
|
||||
|
||||
```markdown
|
||||
## 文档
|
||||
|
||||
- [快速开始](docs/getting-started.md)
|
||||
- [安装指南](docs/installation.md)
|
||||
- [使用说明](docs/usage.md)
|
||||
- [配置说明](docs/configuration.md)
|
||||
- [API 文档](docs/api/index.md)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 7. 完成提示
|
||||
|
||||
> 用户文档已生成：`{{DOCS_PATH}}/`
|
||||
>
|
||||
> 生成的文档：
|
||||
> {{GENERATED_FILES_LIST}}
|
||||
>
|
||||
> 建议：
|
||||
> - 检查生成的内容是否准确
|
||||
> - 在 `<!-- USER-EDIT -->` 标记下方添加自定义内容
|
||||
> - 自定义内容不会被后续更新覆盖
|
||||
>
|
||||
> 如需重新生成，可再次运行 `/aide:user-docs`。
|
||||
|
||||
---
|
||||
|
||||
## 配置项
|
||||
|
||||
| 配置项 | 默认值 | 说明 |
|
||||
|--------|--------|------|
|
||||
| `user_docs.docs_path` | `docs` | 用户文档目录路径 |
|
||||
| `user_docs.rules_path` | `make-readme-rules.md` | README 规范文件路径 |
|
||||
|
||||
---
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. **保留用户编辑**：使用标记区分自动生成和用户编辑的内容
|
||||
2. **风格一致**：文档风格与 README 保持一致
|
||||
3. **增量更新**：多次运行不会覆盖用户自定义内容
|
||||
4. **链接同步**：README 中的文档链接自动更新
|
||||
327
aide-marketplace/aide-plugin/commands/user-graph.md
Normal file
327
aide-marketplace/aide-plugin/commands/user-graph.md
Normal file
@@ -0,0 +1,327 @@
|
||||
# Aide 用户流程图生成
|
||||
|
||||
你正在执行 Aide 用户流程图生成流程。这个命令帮助用户创建面向用户的长期维护流程图系统。
|
||||
|
||||
此命令支持**分步执行**和**接续执行**，适用于大型项目。
|
||||
|
||||
---
|
||||
|
||||
## 前置准备
|
||||
|
||||
**首先检查项目文档是否存在。**
|
||||
|
||||
```bash
|
||||
aide config get docs.path
|
||||
```
|
||||
|
||||
如果项目文档目录（`.aide/project-docs/`）不存在：
|
||||
|
||||
> 用户流程图依赖项目文档来了解项目结构。建议先执行 `/aide:docs` 和 `/aide:load`。
|
||||
|
||||
使用 AskUserQuestion 询问：
|
||||
- **先执行 /aide:docs**（推荐）
|
||||
- **继续（基于代码分析）**
|
||||
|
||||
---
|
||||
|
||||
## 开始
|
||||
|
||||
### 检查计划文件
|
||||
|
||||
```bash
|
||||
aide config get user_docs.graph_plan_path
|
||||
```
|
||||
|
||||
读取配置的计划文件路径，检查文件是否存在。
|
||||
|
||||
**根据计划文件状态决定流程**：
|
||||
|
||||
- **计划文件不存在** → 进入**分析和计划阶段**
|
||||
- **计划文件存在** → 进入**接续执行阶段**
|
||||
|
||||
---
|
||||
|
||||
## 分析和计划阶段
|
||||
|
||||
当 `docs/graph-guide/plan.md` 不存在时执行此流程。
|
||||
|
||||
### 1. 加载项目文档
|
||||
|
||||
读取 `.aide/project-docs/` 下的项目文档：
|
||||
|
||||
1. 读取总导览（`README.md`）获取：
|
||||
- 项目类型（文档/程序/混合）
|
||||
- 子项目/模块列表
|
||||
- 技术栈信息
|
||||
|
||||
2. 阅读相关区块文档了解详细结构
|
||||
|
||||
### 2. 区块划分
|
||||
|
||||
**划分原则**（与项目文档不同）：
|
||||
|
||||
- 目标是呈现**整体形式**
|
||||
- 按**业务逻辑**或**独立开发项目**划分
|
||||
- 不追求深度全覆盖
|
||||
|
||||
**区块类型**：
|
||||
|
||||
| 类型 | 说明 | 典型内容 |
|
||||
|------|------|----------|
|
||||
| 库项目 | 独立的库/工具包 | API 设计、核心逻辑 |
|
||||
| 应用 | 可运行的程序 | 启动流程、业务逻辑 |
|
||||
| 前端 | UI 相关 | 组件结构、数据流 |
|
||||
| 文档 | 纯文档项目 | 内容导航、学习路径 |
|
||||
|
||||
### 3. 复杂度分析
|
||||
|
||||
对每个区块评估：
|
||||
|
||||
| 复杂度 | 特征 | 预估步骤数 |
|
||||
|--------|------|-----------|
|
||||
| 低 | 单模块，逻辑简单 | 2-3 |
|
||||
| 中 | 多模块，有交互 | 4-6 |
|
||||
| 高 | 复杂系统，多层次 | 7+ |
|
||||
|
||||
### 4. 生成计划文档
|
||||
|
||||
在 `docs/graph-guide/` 目录创建 `plan.md`：
|
||||
|
||||
```markdown
|
||||
# 用户流程图编写计划
|
||||
|
||||
## 项目概述
|
||||
|
||||
{{基于项目文档的简要描述}}
|
||||
|
||||
## 区块划分
|
||||
|
||||
| # | 区块名称 | 类型 | 复杂度 | 状态 |
|
||||
|---|----------|------|--------|------|
|
||||
{{BLOCKS_TABLE}}
|
||||
|
||||
## 执行步骤
|
||||
|
||||
### 区块 1: {{BLOCK_1_NAME}}
|
||||
|
||||
- [ ] 步骤 1.1: 分析模块结构
|
||||
- [ ] 步骤 1.2: 编写 guide.puml
|
||||
- [ ] 步骤 1.3: 编写 {{module}}.puml
|
||||
...
|
||||
|
||||
### 区块 2: {{BLOCK_2_NAME}}
|
||||
|
||||
- [ ] 步骤 2.1: ...
|
||||
...
|
||||
|
||||
## 当前进度
|
||||
|
||||
- 当前区块：0（未开始）
|
||||
- 当前步骤：-
|
||||
- 最后更新：{{TIMESTAMP}}
|
||||
|
||||
## 备注
|
||||
|
||||
（执行过程中的记录）
|
||||
```
|
||||
|
||||
### 5. 创建目录结构
|
||||
|
||||
```bash
|
||||
aide config get user_docs.graph_path
|
||||
```
|
||||
|
||||
创建流程图目录和子目录：
|
||||
|
||||
```
|
||||
docs/graph-guide/
|
||||
├── plan.md
|
||||
└── {{block_name}}/ # 每个区块一个目录
|
||||
```
|
||||
|
||||
### 6. 用户确认
|
||||
|
||||
> 流程图编写计划已生成。
|
||||
>
|
||||
> **区块划分**：
|
||||
> {{BLOCKS_SUMMARY}}
|
||||
>
|
||||
> **预估步骤**：共 {{TOTAL_STEPS}} 步
|
||||
>
|
||||
> 是否开始执行？
|
||||
|
||||
**选项**：
|
||||
- **开始执行**（推荐）
|
||||
- **调整计划**
|
||||
- **稍后执行**
|
||||
|
||||
如选择开始执行，进入步骤执行流程。
|
||||
|
||||
---
|
||||
|
||||
## 接续执行阶段
|
||||
|
||||
当 `docs/graph-guide/plan.md` 存在时执行此流程。
|
||||
|
||||
### 1. 读取计划文档
|
||||
|
||||
解析 plan.md 获取：
|
||||
- 区块列表和状态
|
||||
- 当前进度（区块和步骤）
|
||||
- 历史备注
|
||||
|
||||
### 2. 显示进度
|
||||
|
||||
> **流程图编写进度**
|
||||
>
|
||||
> 当前区块：{{CURRENT_BLOCK}}
|
||||
> 当前步骤：{{CURRENT_STEP}}
|
||||
> 已完成步骤：{{COMPLETED_STEPS}}/{{TOTAL_STEPS}}
|
||||
> 上次更新：{{LAST_UPDATE}}
|
||||
|
||||
### 3. 确认继续
|
||||
|
||||
使用 AskUserQuestion：
|
||||
|
||||
> 是否从当前进度继续执行？
|
||||
|
||||
**选项**：
|
||||
- **继续执行**（推荐）
|
||||
- **查看计划详情**
|
||||
- **重新开始**（清空进度）
|
||||
|
||||
---
|
||||
|
||||
## 步骤执行流程
|
||||
|
||||
### 执行单个步骤
|
||||
|
||||
对于每个步骤：
|
||||
|
||||
1. **显示当前任务**：
|
||||
> 正在执行：{{STEP_DESCRIPTION}}
|
||||
|
||||
2. **执行步骤**：
|
||||
- 分析相关代码/文档
|
||||
- 生成/更新 puml 文件
|
||||
|
||||
3. **更新计划文档**：
|
||||
- 标记步骤完成
|
||||
- 更新当前进度
|
||||
- 记录时间戳
|
||||
|
||||
4. **保存产出**：
|
||||
- 写入 puml 文件
|
||||
- 调用 PlantUML 生成 PNG（如配置）
|
||||
|
||||
### 步骤间询问
|
||||
|
||||
每完成一个步骤后询问：
|
||||
|
||||
> 步骤 {{STEP_ID}} 已完成。
|
||||
>
|
||||
> 是否继续下一步？
|
||||
|
||||
**选项**：
|
||||
- **继续**（推荐）
|
||||
- **查看产出**
|
||||
- **暂停（保存进度）**
|
||||
|
||||
如选择暂停，保存进度后结束本次执行。
|
||||
|
||||
---
|
||||
|
||||
## 流程图内容规范
|
||||
|
||||
### 总导览流程图（guide.puml）
|
||||
|
||||
每个区块的 guide.puml 应包含：
|
||||
- 模块概览
|
||||
- 调用关系
|
||||
- 数据流向
|
||||
|
||||
### 详细流程图（module.puml）
|
||||
|
||||
#### 不含程序的项目
|
||||
|
||||
- 内容导航图
|
||||
- 学习路径图
|
||||
- 概念关系图
|
||||
|
||||
#### 含程序的项目
|
||||
|
||||
参考 `/aide:run` 中的程序逻辑流图规范：
|
||||
|
||||
1. **入口点**：从程序入口开始
|
||||
2. **控制结构**：体现顺序、分支、循环
|
||||
3. **语义化抽象**：人类可理解的业务描述
|
||||
4. **模块化表示**：
|
||||
- 函数/模块表示为"盒子"
|
||||
- 标注输入输出
|
||||
5. **层次化组织**：
|
||||
- 主流程图 + 详细子图
|
||||
|
||||
### PlantUML 模板
|
||||
|
||||
```plantuml
|
||||
@startuml guide
|
||||
!theme plain
|
||||
skinparam backgroundColor #FFFFFF
|
||||
|
||||
title {{区块名称}} - 导览
|
||||
|
||||
' 模块定义
|
||||
package "{{Module A}}" {
|
||||
[Component 1]
|
||||
[Component 2]
|
||||
}
|
||||
|
||||
package "{{Module B}}" {
|
||||
[Component 3]
|
||||
}
|
||||
|
||||
' 关系
|
||||
[Component 1] --> [Component 2]
|
||||
[Component 2] --> [Component 3]
|
||||
|
||||
@enduml
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 目录结构
|
||||
|
||||
最终生成的目录结构：
|
||||
|
||||
```
|
||||
docs/graph-guide/
|
||||
├── plan.md # 计划和进度文档
|
||||
├── guide.puml # 总导览流程图（可选）
|
||||
├── {{block-1}}/ # 区块 1
|
||||
│ ├── guide.puml # 区块导览
|
||||
│ ├── module-a.puml # 模块 A 流程图
|
||||
│ └── module-b.puml # 模块 B 流程图
|
||||
├── {{block-2}}/ # 区块 2
|
||||
│ ├── guide.puml
|
||||
│ └── ...
|
||||
└── ...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 配置项
|
||||
|
||||
| 配置项 | 默认值 | 说明 |
|
||||
|--------|--------|------|
|
||||
| `user_docs.graph_path` | `docs/graph-guide` | 流程图目录路径 |
|
||||
| `user_docs.graph_plan_path` | `docs/graph-guide/plan.md` | 计划文件路径 |
|
||||
|
||||
---
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. **分步执行**：大型项目建议分多次对话完成
|
||||
2. **进度持久化**：进度保存在 plan.md，可随时接续
|
||||
3. **PNG 生成**：需要配置 PlantUML（参考 `[plantuml]` 配置）
|
||||
4. **与项目文档关联**：依赖项目文档了解项目结构
|
||||
5. **用户参与**：关键决策需用户确认
|
||||
Reference in New Issue
Block a user