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. **用户参与**：关键决策需用户确认
|
||||
@@ -146,9 +146,34 @@ aide flow next-part impl "流程设计完成，开始实现"
|
||||
aide flow back-part <环节名> "<原因>"
|
||||
```
|
||||
|
||||
**注意**：执行 back-part 时会生成一个确认 key，需要先完成准备工作后执行 back-confirm 确认。
|
||||
|
||||
**示例**：
|
||||
```bash
|
||||
aide flow back-part flow-design "实现中发现设计遗漏，需要补充"
|
||||
# 输出: ⚠ 返工需要确认。请先完成准备工作，然后执行:
|
||||
# aide flow back-confirm --key abc123
|
||||
```
|
||||
|
||||
### aide flow back-confirm
|
||||
|
||||
确认返工请求并执行。
|
||||
|
||||
```bash
|
||||
aide flow back-confirm --key <key>
|
||||
```
|
||||
|
||||
**参数**：
|
||||
|
||||
| 参数 | 说明 |
|
||||
|------|------|
|
||||
| `--key` | back-part 生成的确认 key |
|
||||
|
||||
**示例**：
|
||||
```bash
|
||||
aide flow back-confirm --key abc123
|
||||
# 输出: ⚠ 回退到环节: flow-design
|
||||
# ⚠ 建议执行 /exit 重新开始对话
|
||||
```
|
||||
|
||||
### aide flow issue
|
||||
|
||||
106
aide-marketplace/aide-plugin/skills/readme-templates/SKILL.md
Normal file
106
aide-marketplace/aide-plugin/skills/readme-templates/SKILL.md
Normal file
@@ -0,0 +1,106 @@
|
||||
---
|
||||
name: readme-templates
|
||||
description: README 模板集。提供多种项目类型的 README 模板和可选模块，供 /aide:readme 命令使用。当需要生成或更新项目 README 时使用。
|
||||
---
|
||||
|
||||
# README 模板集
|
||||
|
||||
本 skill 提供一套完整的 README 模板体系，包含多种项目类型模板和可组合的功能模块。
|
||||
|
||||
## 模板选择指南
|
||||
|
||||
根据项目类型选择合适的基础模板：
|
||||
|
||||
| 项目类型 | 推荐模板 | 特点 |
|
||||
|----------|----------|------|
|
||||
| 小工具/脚本 | `minimal.md` | 精简，核心信息 |
|
||||
| 库/SDK | `library.md` | 安装、API、示例 |
|
||||
| 应用程序 | `application.md` | 功能、安装、配置 |
|
||||
| 文档/教程 | `documentation.md` | 结构清晰、导航便捷 |
|
||||
| 多项目仓库 | `monorepo.md` | 子项目索引、统一说明 |
|
||||
|
||||
## 模板结构
|
||||
|
||||
### templates/ - 完整模板
|
||||
|
||||
每个模板都是独立完整的 README 结构，包含该类型项目最常用的章节。
|
||||
|
||||
### modules/ - 可选模块
|
||||
|
||||
模块是可自由组合的内容块，用于扩展或定制 README：
|
||||
|
||||
| 模块 | 用途 | 推荐场景 |
|
||||
|------|------|----------|
|
||||
| `quickstart` | 5分钟上手 | 希望用户快速体验 |
|
||||
| `installation` | 详细安装 | 有多种安装方式 |
|
||||
| `examples` | 代码示例 | API 或工具类项目 |
|
||||
| `api` | 接口文档 | 库/SDK 项目 |
|
||||
| `configuration` | 配置说明 | 有配置文件的项目 |
|
||||
| `architecture` | 架构概述 | 复杂系统 |
|
||||
| `contributing` | 贡献指南 | 开源项目 |
|
||||
| `changelog` | 变更日志 | 需要版本追踪 |
|
||||
| `license` | 许可证 | 所有公开项目 |
|
||||
| `faq` | 常见问题 | 用户问题较多 |
|
||||
|
||||
## 推荐组合
|
||||
|
||||
### 开源库项目
|
||||
|
||||
```
|
||||
模板: library.md
|
||||
模块: + quickstart + examples + api + contributing + license
|
||||
```
|
||||
|
||||
### 内部工具项目
|
||||
|
||||
```
|
||||
模板: application.md
|
||||
模块: + installation + configuration + faq
|
||||
```
|
||||
|
||||
### 文档项目
|
||||
|
||||
```
|
||||
模板: documentation.md
|
||||
模块: + contributing
|
||||
```
|
||||
|
||||
### 微型脚本
|
||||
|
||||
```
|
||||
模板: minimal.md
|
||||
模块: （无需额外模块）
|
||||
```
|
||||
|
||||
## 占位符说明
|
||||
|
||||
模板中使用以下占位符，需根据实际项目填充：
|
||||
|
||||
| 占位符 | 说明 |
|
||||
|--------|------|
|
||||
| `{{PROJECT_NAME}}` | 项目名称 |
|
||||
| `{{PROJECT_DESCRIPTION}}` | 项目简介（一句话） |
|
||||
| `{{BADGE_SECTION}}` | 徽章区（可选） |
|
||||
| `{{FEATURES}}` | 功能特性列表 |
|
||||
| `{{INSTALLATION}}` | 安装步骤 |
|
||||
| `{{USAGE}}` | 基本用法 |
|
||||
| `{{EXAMPLES}}` | 示例代码 |
|
||||
| `{{API_DOCS}}` | API 文档 |
|
||||
| `{{CONFIGURATION}}` | 配置说明 |
|
||||
| `{{LICENSE}}` | 许可证类型 |
|
||||
| `{{AUTHOR}}` | 作者信息 |
|
||||
|
||||
## 使用方式
|
||||
|
||||
1. 根据项目类型选择基础模板
|
||||
2. 阅读项目代码，提取关键信息
|
||||
3. 根据需要添加可选模块
|
||||
4. 填充占位符，生成最终 README
|
||||
|
||||
## 编写原则
|
||||
|
||||
1. **用户视角**：从使用者角度组织内容
|
||||
2. **渐进披露**：重要信息在前，细节在后
|
||||
3. **可执行**：示例代码可直接运行
|
||||
4. **保持更新**：与代码同步更新
|
||||
5. **简洁明了**：避免冗余，突出重点
|
||||
@@ -0,0 +1,89 @@
|
||||
<!--
|
||||
模块：api（API 文档）
|
||||
用途：详细的接口说明
|
||||
位置：库项目的核心章节
|
||||
-->
|
||||
|
||||
## API 文档
|
||||
|
||||
### 概览
|
||||
|
||||
{{API_OVERVIEW}}
|
||||
|
||||
### 核心 API
|
||||
|
||||
#### `{{FUNCTION_1_NAME}}`
|
||||
|
||||
{{FUNCTION_1_DESCRIPTION}}
|
||||
|
||||
**签名**：
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{FUNCTION_1_SIGNATURE}}
|
||||
```
|
||||
|
||||
**参数**：
|
||||
|
||||
| 参数 | 类型 | 必需 | 说明 |
|
||||
|------|------|------|------|
|
||||
{{FUNCTION_1_PARAMS}}
|
||||
|
||||
**返回值**：
|
||||
|
||||
{{FUNCTION_1_RETURN}}
|
||||
|
||||
**示例**：
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{FUNCTION_1_EXAMPLE}}
|
||||
```
|
||||
|
||||
#### `{{FUNCTION_2_NAME}}`
|
||||
|
||||
{{FUNCTION_2_DESCRIPTION}}
|
||||
|
||||
**签名**：
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{FUNCTION_2_SIGNATURE}}
|
||||
```
|
||||
|
||||
**参数**：
|
||||
|
||||
| 参数 | 类型 | 必需 | 说明 |
|
||||
|------|------|------|------|
|
||||
{{FUNCTION_2_PARAMS}}
|
||||
|
||||
**返回值**：
|
||||
|
||||
{{FUNCTION_2_RETURN}}
|
||||
|
||||
### 类型定义
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{TYPE_DEFINITIONS}}
|
||||
```
|
||||
|
||||
### 常量
|
||||
|
||||
| 常量 | 值 | 说明 |
|
||||
|------|-----|------|
|
||||
{{CONSTANTS_TABLE}}
|
||||
|
||||
### 错误处理
|
||||
|
||||
| 错误码 | 说明 | 处理建议 |
|
||||
|--------|------|----------|
|
||||
{{ERRORS_TABLE}}
|
||||
|
||||
### 完整 API 参考
|
||||
|
||||
详细的 API 文档请查看 [API Reference]({{API_REFERENCE_URL}})。
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 每个函数都有签名、参数、返回值、示例
|
||||
- 类型定义要完整
|
||||
- 说明错误处理方式
|
||||
- 保持格式统一
|
||||
-->
|
||||
@@ -0,0 +1,77 @@
|
||||
<!--
|
||||
模块：architecture（架构概述）
|
||||
用途：说明系统架构和设计
|
||||
位置：复杂项目的重要章节
|
||||
-->
|
||||
|
||||
## 架构
|
||||
|
||||
### 系统概览
|
||||
|
||||
{{SYSTEM_OVERVIEW}}
|
||||
|
||||
### 架构图
|
||||
|
||||
```
|
||||
{{ARCHITECTURE_DIAGRAM}}
|
||||
```
|
||||
|
||||
### 核心组件
|
||||
|
||||
| 组件 | 职责 | 技术 |
|
||||
|------|------|------|
|
||||
{{COMPONENTS_TABLE}}
|
||||
|
||||
### 数据流
|
||||
|
||||
```
|
||||
{{DATA_FLOW_DIAGRAM}}
|
||||
```
|
||||
|
||||
### 目录结构
|
||||
|
||||
```
|
||||
{{DIRECTORY_STRUCTURE}}
|
||||
```
|
||||
|
||||
### 模块说明
|
||||
|
||||
#### {{MODULE_1_NAME}}
|
||||
|
||||
- **职责**：{{MODULE_1_RESPONSIBILITY}}
|
||||
- **位置**：`{{MODULE_1_PATH}}`
|
||||
- **依赖**：{{MODULE_1_DEPENDENCIES}}
|
||||
|
||||
#### {{MODULE_2_NAME}}
|
||||
|
||||
- **职责**：{{MODULE_2_RESPONSIBILITY}}
|
||||
- **位置**：`{{MODULE_2_PATH}}`
|
||||
- **依赖**：{{MODULE_2_DEPENDENCIES}}
|
||||
|
||||
### 技术选型
|
||||
|
||||
| 领域 | 选择 | 原因 |
|
||||
|------|------|------|
|
||||
{{TECH_CHOICES_TABLE}}
|
||||
|
||||
### 设计决策
|
||||
|
||||
#### {{DECISION_1_TITLE}}
|
||||
|
||||
**背景**：{{DECISION_1_CONTEXT}}
|
||||
|
||||
**方案**：{{DECISION_1_SOLUTION}}
|
||||
|
||||
**权衡**：{{DECISION_1_TRADEOFFS}}
|
||||
|
||||
### 扩展点
|
||||
|
||||
{{EXTENSION_POINTS}}
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 图文结合说明架构
|
||||
- 清晰说明各组件职责
|
||||
- 记录重要设计决策
|
||||
- 说明扩展方式
|
||||
-->
|
||||
@@ -0,0 +1,71 @@
|
||||
<!--
|
||||
模块：changelog（变更日志）
|
||||
用途：版本历史和变更记录
|
||||
位置：通常作为独立文件或 README 章节
|
||||
-->
|
||||
|
||||
## 变更日志
|
||||
|
||||
所有重要的变更都会记录在此文件中。
|
||||
|
||||
格式基于 [Keep a Changelog](https://keepachangelog.com/)，
|
||||
版本号遵循 [语义化版本](https://semver.org/)。
|
||||
|
||||
### [Unreleased]
|
||||
|
||||
#### 新增
|
||||
- {{UNRELEASED_ADDED}}
|
||||
|
||||
#### 变更
|
||||
- {{UNRELEASED_CHANGED}}
|
||||
|
||||
#### 修复
|
||||
- {{UNRELEASED_FIXED}}
|
||||
|
||||
---
|
||||
|
||||
### [{{VERSION_1}}] - {{DATE_1}}
|
||||
|
||||
#### 新增
|
||||
- {{V1_ADDED_1}}
|
||||
- {{V1_ADDED_2}}
|
||||
|
||||
#### 变更
|
||||
- {{V1_CHANGED_1}}
|
||||
|
||||
#### 修复
|
||||
- {{V1_FIXED_1}}
|
||||
|
||||
#### 移除
|
||||
- {{V1_REMOVED_1}}
|
||||
|
||||
---
|
||||
|
||||
### [{{VERSION_2}}] - {{DATE_2}}
|
||||
|
||||
#### 新增
|
||||
- {{V2_ADDED_1}}
|
||||
|
||||
#### 修复
|
||||
- {{V2_FIXED_1}}
|
||||
|
||||
---
|
||||
|
||||
### [{{VERSION_INITIAL}}] - {{DATE_INITIAL}}
|
||||
|
||||
- 首次发布
|
||||
|
||||
---
|
||||
|
||||
[Unreleased]: {{COMPARE_UNRELEASED_URL}}
|
||||
[{{VERSION_1}}]: {{COMPARE_V1_URL}}
|
||||
[{{VERSION_2}}]: {{COMPARE_V2_URL}}
|
||||
[{{VERSION_INITIAL}}]: {{TAG_INITIAL_URL}}
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 按版本倒序排列
|
||||
- 每个版本包含：新增、变更、修复、移除
|
||||
- 提供版本对比链接
|
||||
- 保持格式一致
|
||||
-->
|
||||
@@ -0,0 +1,85 @@
|
||||
<!--
|
||||
模块：configuration（配置说明）
|
||||
用途：详细的配置项说明
|
||||
位置：安装/使用之后
|
||||
-->
|
||||
|
||||
## 配置
|
||||
|
||||
### 配置文件
|
||||
|
||||
配置文件位置：`{{CONFIG_PATH}}`
|
||||
|
||||
首次运行会自动生成默认配置。
|
||||
|
||||
### 配置方式
|
||||
|
||||
#### 1. 配置文件
|
||||
|
||||
编辑 `{{CONFIG_FILE}}`：
|
||||
|
||||
```{{CONFIG_FORMAT}}
|
||||
{{CONFIG_EXAMPLE}}
|
||||
```
|
||||
|
||||
#### 2. 环境变量
|
||||
|
||||
```bash
|
||||
{{ENV_VARS_EXAMPLE}}
|
||||
```
|
||||
|
||||
#### 3. 命令行参数
|
||||
|
||||
```bash
|
||||
{{CLI_ARGS_EXAMPLE}}
|
||||
```
|
||||
|
||||
**优先级**：命令行参数 > 环境变量 > 配置文件
|
||||
|
||||
### 配置项详解
|
||||
|
||||
#### `{{CONFIG_SECTION_1}}`
|
||||
|
||||
| 配置项 | 类型 | 默认值 | 说明 |
|
||||
|--------|------|--------|------|
|
||||
{{CONFIG_SECTION_1_TABLE}}
|
||||
|
||||
#### `{{CONFIG_SECTION_2}}`
|
||||
|
||||
| 配置项 | 类型 | 默认值 | 说明 |
|
||||
|--------|------|--------|------|
|
||||
{{CONFIG_SECTION_2_TABLE}}
|
||||
|
||||
### 完整配置示例
|
||||
|
||||
```{{CONFIG_FORMAT}}
|
||||
{{FULL_CONFIG_EXAMPLE}}
|
||||
```
|
||||
|
||||
### 配置验证
|
||||
|
||||
```bash
|
||||
{{VALIDATE_CONFIG_COMMAND}}
|
||||
```
|
||||
|
||||
### 常见配置场景
|
||||
|
||||
#### 场景 1：{{SCENARIO_1_NAME}}
|
||||
|
||||
```{{CONFIG_FORMAT}}
|
||||
{{SCENARIO_1_CONFIG}}
|
||||
```
|
||||
|
||||
#### 场景 2：{{SCENARIO_2_NAME}}
|
||||
|
||||
```{{CONFIG_FORMAT}}
|
||||
{{SCENARIO_2_CONFIG}}
|
||||
```
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 说明所有配置方式
|
||||
- 每个配置项有类型、默认值、说明
|
||||
- 提供实际场景配置示例
|
||||
- 说明优先级和验证方法
|
||||
-->
|
||||
@@ -0,0 +1,95 @@
|
||||
<!--
|
||||
模块：contributing（贡献指南）
|
||||
用途：指导如何为项目做贡献
|
||||
位置：开源项目必备
|
||||
-->
|
||||
|
||||
## 贡献指南
|
||||
|
||||
感谢你考虑为 {{PROJECT_NAME}} 做贡献！
|
||||
|
||||
### 贡献方式
|
||||
|
||||
- 报告 Bug
|
||||
- 提交功能建议
|
||||
- 改进文档
|
||||
- 提交代码 PR
|
||||
|
||||
### 开发环境
|
||||
|
||||
#### 环境要求
|
||||
|
||||
{{DEV_REQUIREMENTS}}
|
||||
|
||||
#### 环境搭建
|
||||
|
||||
```bash
|
||||
# 克隆仓库
|
||||
git clone {{REPO_URL}}
|
||||
cd {{PROJECT_DIR}}
|
||||
|
||||
# 安装依赖
|
||||
{{INSTALL_DEPS}}
|
||||
|
||||
# 运行测试
|
||||
{{RUN_TESTS}}
|
||||
```
|
||||
|
||||
### 代码规范
|
||||
|
||||
{{CODE_STYLE}}
|
||||
|
||||
#### 提交信息格式
|
||||
|
||||
```
|
||||
<type>(<scope>): <subject>
|
||||
|
||||
<body>
|
||||
|
||||
<footer>
|
||||
```
|
||||
|
||||
**type 类型**：
|
||||
- `feat`: 新功能
|
||||
- `fix`: 修复 Bug
|
||||
- `docs`: 文档更新
|
||||
- `style`: 代码格式
|
||||
- `refactor`: 重构
|
||||
- `test`: 测试相关
|
||||
- `chore`: 构建/工具
|
||||
|
||||
### 提交 PR
|
||||
|
||||
1. Fork 本仓库
|
||||
2. 创建特性分支：`git checkout -b feature/your-feature`
|
||||
3. 提交更改：`git commit -m 'feat: add some feature'`
|
||||
4. 推送分支：`git push origin feature/your-feature`
|
||||
5. 创建 Pull Request
|
||||
|
||||
### PR 检查清单
|
||||
|
||||
- [ ] 代码通过所有测试
|
||||
- [ ] 新功能有对应测试
|
||||
- [ ] 更新了相关文档
|
||||
- [ ] 提交信息格式正确
|
||||
|
||||
### 代码审查
|
||||
|
||||
所有 PR 都需要至少一位维护者审查后才能合并。
|
||||
|
||||
### 行为准则
|
||||
|
||||
请阅读并遵守我们的 [行为准则](CODE_OF_CONDUCT.md)。
|
||||
|
||||
### 联系方式
|
||||
|
||||
- 问题讨论：[GitHub Discussions]({{DISCUSSIONS_URL}})
|
||||
- Bug 报告：[GitHub Issues]({{ISSUES_URL}})
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 清晰说明贡献流程
|
||||
- 提供开发环境搭建指南
|
||||
- 说明代码规范
|
||||
- 包含 PR 检查清单
|
||||
-->
|
||||
@@ -0,0 +1,71 @@
|
||||
<!--
|
||||
模块：examples（使用示例）
|
||||
用途：展示典型用例和代码示例
|
||||
位置：通常放在基本用法之后
|
||||
-->
|
||||
|
||||
## 示例
|
||||
|
||||
### 基础示例
|
||||
|
||||
#### {{EXAMPLE_1_NAME}}
|
||||
|
||||
{{EXAMPLE_1_DESCRIPTION}}
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{EXAMPLE_1_CODE}}
|
||||
```
|
||||
|
||||
输出：
|
||||
|
||||
```
|
||||
{{EXAMPLE_1_OUTPUT}}
|
||||
```
|
||||
|
||||
#### {{EXAMPLE_2_NAME}}
|
||||
|
||||
{{EXAMPLE_2_DESCRIPTION}}
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{EXAMPLE_2_CODE}}
|
||||
```
|
||||
|
||||
### 进阶示例
|
||||
|
||||
#### {{ADVANCED_EXAMPLE_NAME}}
|
||||
|
||||
{{ADVANCED_EXAMPLE_DESCRIPTION}}
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{ADVANCED_EXAMPLE_CODE}}
|
||||
```
|
||||
|
||||
### 实际场景
|
||||
|
||||
#### 场景：{{SCENARIO_NAME}}
|
||||
|
||||
**需求**：{{SCENARIO_REQUIREMENT}}
|
||||
|
||||
**解决方案**：
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{SCENARIO_CODE}}
|
||||
```
|
||||
|
||||
**说明**：{{SCENARIO_EXPLANATION}}
|
||||
|
||||
### 完整示例项目
|
||||
|
||||
查看 [examples/](examples/) 目录获取完整的示例项目：
|
||||
|
||||
| 示例 | 说明 | 难度 |
|
||||
|------|------|------|
|
||||
{{EXAMPLES_TABLE}}
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 从简单到复杂递进
|
||||
- 示例代码可直接运行
|
||||
- 包含输出帮助理解
|
||||
- 解释关键代码逻辑
|
||||
-->
|
||||
@@ -0,0 +1,85 @@
|
||||
<!--
|
||||
模块：faq（常见问题）
|
||||
用途：解答用户常见问题
|
||||
位置：文档末尾或独立页面
|
||||
-->
|
||||
|
||||
## 常见问题
|
||||
|
||||
### 一般问题
|
||||
|
||||
#### Q: {{GENERAL_Q1}}
|
||||
|
||||
**A**: {{GENERAL_A1}}
|
||||
|
||||
#### Q: {{GENERAL_Q2}}
|
||||
|
||||
**A**: {{GENERAL_A2}}
|
||||
|
||||
### 安装问题
|
||||
|
||||
#### Q: {{INSTALL_Q1}}
|
||||
|
||||
**A**: {{INSTALL_A1}}
|
||||
|
||||
```bash
|
||||
{{INSTALL_SOLUTION_1}}
|
||||
```
|
||||
|
||||
#### Q: {{INSTALL_Q2}}
|
||||
|
||||
**A**: {{INSTALL_A2}}
|
||||
|
||||
### 使用问题
|
||||
|
||||
#### Q: {{USAGE_Q1}}
|
||||
|
||||
**A**: {{USAGE_A1}}
|
||||
|
||||
示例：
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{USAGE_EXAMPLE_1}}
|
||||
```
|
||||
|
||||
#### Q: {{USAGE_Q2}}
|
||||
|
||||
**A**: {{USAGE_A2}}
|
||||
|
||||
### 故障排除
|
||||
|
||||
#### Q: {{TROUBLE_Q1}}
|
||||
|
||||
**A**: {{TROUBLE_A1}}
|
||||
|
||||
排查步骤：
|
||||
|
||||
1. {{TROUBLE_STEP_1}}
|
||||
2. {{TROUBLE_STEP_2}}
|
||||
3. {{TROUBLE_STEP_3}}
|
||||
|
||||
#### Q: {{TROUBLE_Q2}}
|
||||
|
||||
**A**: {{TROUBLE_A2}}
|
||||
|
||||
### 性能问题
|
||||
|
||||
#### Q: {{PERF_Q1}}
|
||||
|
||||
**A**: {{PERF_A1}}
|
||||
|
||||
### 其他问题
|
||||
|
||||
没有找到你的问题？
|
||||
|
||||
- 搜索 [Issues]({{ISSUES_URL}}) 看是否有人遇到过类似问题
|
||||
- 在 [Discussions]({{DISCUSSIONS_URL}}) 中提问
|
||||
- 提交新的 [Issue]({{NEW_ISSUE_URL}})
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 按类别组织问题
|
||||
- 问题简洁，答案详细
|
||||
- 包含代码示例和排查步骤
|
||||
- 提供进一步帮助的链接
|
||||
-->
|
||||
@@ -0,0 +1,88 @@
|
||||
<!--
|
||||
模块：installation（安装指南）
|
||||
用途：详细的多平台安装说明
|
||||
位置：通常放在功能特性之后
|
||||
-->
|
||||
|
||||
## 安装
|
||||
|
||||
### 系统要求
|
||||
|
||||
{{SYSTEM_REQUIREMENTS}}
|
||||
|
||||
### 方式一：包管理器（推荐）
|
||||
|
||||
#### macOS
|
||||
|
||||
```bash
|
||||
{{INSTALL_MACOS}}
|
||||
```
|
||||
|
||||
#### Linux
|
||||
|
||||
```bash
|
||||
{{INSTALL_LINUX}}
|
||||
```
|
||||
|
||||
#### Windows
|
||||
|
||||
```powershell
|
||||
{{INSTALL_WINDOWS}}
|
||||
```
|
||||
|
||||
### 方式二：预编译二进制
|
||||
|
||||
从 [Releases]({{RELEASES_URL}}) 下载对应平台的版本：
|
||||
|
||||
| 平台 | 架构 | 下载 |
|
||||
|------|------|------|
|
||||
| macOS | Intel/ARM | {{DOWNLOAD_MACOS}} |
|
||||
| Linux | x64/ARM | {{DOWNLOAD_LINUX}} |
|
||||
| Windows | x64 | {{DOWNLOAD_WINDOWS}} |
|
||||
|
||||
### 方式三：从源码构建
|
||||
|
||||
```bash
|
||||
# 克隆仓库
|
||||
git clone {{REPO_URL}}
|
||||
cd {{PROJECT_DIR}}
|
||||
|
||||
# 安装依赖
|
||||
{{INSTALL_DEPS}}
|
||||
|
||||
# 构建
|
||||
{{BUILD_COMMAND}}
|
||||
|
||||
# 安装到系统
|
||||
{{INSTALL_LOCAL}}
|
||||
```
|
||||
|
||||
### 验证安装
|
||||
|
||||
```bash
|
||||
{{VERIFY_COMMAND}}
|
||||
```
|
||||
|
||||
预期输出：
|
||||
|
||||
```
|
||||
{{VERIFY_OUTPUT}}
|
||||
```
|
||||
|
||||
### 常见问题
|
||||
|
||||
#### 问题 1：{{ISSUE_1}}
|
||||
|
||||
{{SOLUTION_1}}
|
||||
|
||||
#### 问题 2：{{ISSUE_2}}
|
||||
|
||||
{{SOLUTION_2}}
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 覆盖主流平台
|
||||
- 提供多种安装方式
|
||||
- 包含验证步骤
|
||||
- 列出常见安装问题
|
||||
-->
|
||||
@@ -0,0 +1,88 @@
|
||||
<!--
|
||||
模块：license（许可证）
|
||||
用途：说明项目许可证
|
||||
位置：README 末尾
|
||||
-->
|
||||
|
||||
## 许可证
|
||||
|
||||
本项目采用 {{LICENSE_NAME}} 许可证。
|
||||
|
||||
### 简要说明
|
||||
|
||||
{{LICENSE_SUMMARY}}
|
||||
|
||||
### 你可以
|
||||
|
||||
- {{CAN_1}}
|
||||
- {{CAN_2}}
|
||||
- {{CAN_3}}
|
||||
|
||||
### 你不可以
|
||||
|
||||
- {{CANNOT_1}}
|
||||
- {{CANNOT_2}}
|
||||
|
||||
### 你必须
|
||||
|
||||
- {{MUST_1}}
|
||||
- {{MUST_2}}
|
||||
|
||||
### 完整许可证
|
||||
|
||||
查看 [LICENSE](LICENSE) 文件获取完整许可证文本。
|
||||
|
||||
---
|
||||
|
||||
**常用许可证模板**：
|
||||
|
||||
#### MIT
|
||||
|
||||
```
|
||||
MIT License
|
||||
|
||||
Copyright (c) {{YEAR}} {{AUTHOR}}
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
```
|
||||
|
||||
#### Apache 2.0
|
||||
|
||||
```
|
||||
Copyright {{YEAR}} {{AUTHOR}}
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
```
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 选择合适的许可证
|
||||
- 简要说明权限和限制
|
||||
- 提供完整许可证链接
|
||||
-->
|
||||
@@ -0,0 +1,47 @@
|
||||
<!--
|
||||
模块：quickstart（快速开始）
|
||||
用途：让用户在 5 分钟内体验核心功能
|
||||
位置：通常放在安装之后
|
||||
-->
|
||||
|
||||
## 快速开始
|
||||
|
||||
只需 3 步，即可体验 {{PROJECT_NAME}} 的核心功能：
|
||||
|
||||
### 1. 安装
|
||||
|
||||
```bash
|
||||
{{INSTALL_COMMAND}}
|
||||
```
|
||||
|
||||
### 2. 初始化
|
||||
|
||||
```bash
|
||||
{{INIT_COMMAND}}
|
||||
```
|
||||
|
||||
### 3. 运行
|
||||
|
||||
```bash
|
||||
{{RUN_COMMAND}}
|
||||
```
|
||||
|
||||
**预期输出**：
|
||||
|
||||
```
|
||||
{{EXPECTED_OUTPUT}}
|
||||
```
|
||||
|
||||
### 下一步
|
||||
|
||||
- [完整使用指南](#使用说明)
|
||||
- [配置选项](#配置)
|
||||
- [更多示例](#示例)
|
||||
|
||||
<!--
|
||||
编写提示：
|
||||
- 保持步骤简洁，最多 3-5 步
|
||||
- 每步都应有可执行的命令
|
||||
- 包含预期输出帮助用户验证
|
||||
- 链接到更详细的文档
|
||||
-->
|
||||
@@ -0,0 +1,97 @@
|
||||
<!--
|
||||
模板：application（应用程序）
|
||||
适用：CLI 工具、GUI 应用、Web 应用、后端服务
|
||||
特点：安装部署清晰、功能完整、配置详细
|
||||
-->
|
||||
|
||||
# {{PROJECT_NAME}}
|
||||
|
||||
{{BADGE_SECTION}}
|
||||
|
||||
{{PROJECT_DESCRIPTION}}
|
||||
|
||||
## 功能特性
|
||||
|
||||
{{FEATURES}}
|
||||
|
||||
## 截图/演示
|
||||
|
||||
{{SCREENSHOTS}}
|
||||
|
||||
## 系统要求
|
||||
|
||||
{{REQUIREMENTS}}
|
||||
|
||||
## 安装
|
||||
|
||||
### 方式一：预编译版本
|
||||
|
||||
{{INSTALL_BINARY}}
|
||||
|
||||
### 方式二：从源码构建
|
||||
|
||||
{{INSTALL_SOURCE}}
|
||||
|
||||
## 快速开始
|
||||
|
||||
{{QUICKSTART}}
|
||||
|
||||
## 使用说明
|
||||
|
||||
### 基本命令
|
||||
|
||||
{{BASIC_COMMANDS}}
|
||||
|
||||
### 常用操作
|
||||
|
||||
{{COMMON_OPERATIONS}}
|
||||
|
||||
## 配置
|
||||
|
||||
### 配置文件位置
|
||||
|
||||
{{CONFIG_LOCATION}}
|
||||
|
||||
### 配置项说明
|
||||
|
||||
{{CONFIG_OPTIONS}}
|
||||
|
||||
### 配置示例
|
||||
|
||||
```
|
||||
{{CONFIG_EXAMPLE}}
|
||||
```
|
||||
|
||||
## 开发
|
||||
|
||||
### 环境搭建
|
||||
|
||||
{{DEV_SETUP}}
|
||||
|
||||
### 构建
|
||||
|
||||
{{BUILD}}
|
||||
|
||||
### 测试
|
||||
|
||||
{{TEST}}
|
||||
|
||||
## 常见问题
|
||||
|
||||
{{FAQ}}
|
||||
|
||||
## 更新日志
|
||||
|
||||
查看 [CHANGELOG.md](CHANGELOG.md) 了解版本历史。
|
||||
|
||||
## 贡献
|
||||
|
||||
欢迎贡献！请查看 [贡献指南](CONTRIBUTING.md)。
|
||||
|
||||
## 许可证
|
||||
|
||||
{{LICENSE}}
|
||||
|
||||
## 致谢
|
||||
|
||||
{{ACKNOWLEDGEMENTS}}
|
||||
@@ -0,0 +1,64 @@
|
||||
<!--
|
||||
模板：documentation（纯文档）
|
||||
适用：教程、指南、规范文档、知识库、材料集
|
||||
特点：结构清晰、导航便捷、内容为主
|
||||
-->
|
||||
|
||||
# {{PROJECT_NAME}}
|
||||
|
||||
{{PROJECT_DESCRIPTION}}
|
||||
|
||||
## 目录
|
||||
|
||||
{{TOC}}
|
||||
|
||||
## 概述
|
||||
|
||||
{{OVERVIEW}}
|
||||
|
||||
## 目标读者
|
||||
|
||||
{{AUDIENCE}}
|
||||
|
||||
## 如何阅读
|
||||
|
||||
{{READING_GUIDE}}
|
||||
|
||||
## 文档结构
|
||||
|
||||
```
|
||||
{{STRUCTURE}}
|
||||
```
|
||||
|
||||
## 快速导航
|
||||
|
||||
| 主题 | 文档 | 说明 |
|
||||
|------|------|------|
|
||||
{{NAV_TABLE}}
|
||||
|
||||
## 入门指南
|
||||
|
||||
{{GETTING_STARTED}}
|
||||
|
||||
## 核心概念
|
||||
|
||||
{{CORE_CONCEPTS}}
|
||||
|
||||
## 参考资料
|
||||
|
||||
{{REFERENCES}}
|
||||
|
||||
## 贡献
|
||||
|
||||
欢迎改进文档！
|
||||
|
||||
- 发现错误：提交 Issue
|
||||
- 内容建议：提交 PR
|
||||
|
||||
## 版本历史
|
||||
|
||||
{{VERSION_HISTORY}}
|
||||
|
||||
## 许可证
|
||||
|
||||
{{LICENSE}}
|
||||
@@ -0,0 +1,69 @@
|
||||
<!--
|
||||
模板：library（库/工具）
|
||||
适用：npm/cargo/pip/gem 等包管理器发布的库、SDK、工具包
|
||||
特点：安装优先、API 清晰、示例丰富
|
||||
-->
|
||||
|
||||
# {{PROJECT_NAME}}
|
||||
|
||||
{{BADGE_SECTION}}
|
||||
|
||||
{{PROJECT_DESCRIPTION}}
|
||||
|
||||
## 功能特性
|
||||
|
||||
{{FEATURES}}
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
{{INSTALLATION}}
|
||||
```
|
||||
|
||||
## 快速开始
|
||||
|
||||
```
|
||||
{{QUICKSTART_CODE}}
|
||||
```
|
||||
|
||||
## API 文档
|
||||
|
||||
{{API_DOCS}}
|
||||
|
||||
### 核心方法
|
||||
|
||||
{{CORE_METHODS}}
|
||||
|
||||
### 配置选项
|
||||
|
||||
{{OPTIONS}}
|
||||
|
||||
## 示例
|
||||
|
||||
### 基础用法
|
||||
|
||||
```
|
||||
{{EXAMPLE_BASIC}}
|
||||
```
|
||||
|
||||
### 进阶用法
|
||||
|
||||
```
|
||||
{{EXAMPLE_ADVANCED}}
|
||||
```
|
||||
|
||||
## 兼容性
|
||||
|
||||
{{COMPATIBILITY}}
|
||||
|
||||
## 贡献
|
||||
|
||||
欢迎贡献代码！请查看 [贡献指南](CONTRIBUTING.md)。
|
||||
|
||||
## 许可证
|
||||
|
||||
{{LICENSE}}
|
||||
|
||||
## 作者
|
||||
|
||||
{{AUTHOR}}
|
||||
@@ -0,0 +1,36 @@
|
||||
<!--
|
||||
模板：minimal（微型项目）
|
||||
适用：< 500 行代码的小工具、脚本、单文件项目
|
||||
特点：精简、聚焦核心功能、快速理解
|
||||
-->
|
||||
|
||||
# {{PROJECT_NAME}}
|
||||
|
||||
{{PROJECT_DESCRIPTION}}
|
||||
|
||||
## 用法
|
||||
|
||||
```bash
|
||||
{{USAGE}}
|
||||
```
|
||||
|
||||
## 示例
|
||||
|
||||
```
|
||||
{{EXAMPLES}}
|
||||
```
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
{{INSTALLATION}}
|
||||
```
|
||||
|
||||
<!-- 可选：如有配置项 -->
|
||||
## 配置
|
||||
|
||||
{{CONFIGURATION}}
|
||||
|
||||
## 许可证
|
||||
|
||||
{{LICENSE}}
|
||||
@@ -0,0 +1,101 @@
|
||||
<!--
|
||||
模板：monorepo（多项目仓库）
|
||||
适用：包含多个子项目的仓库、工作区项目
|
||||
特点：子项目索引、统一说明、各项目独立介绍
|
||||
-->
|
||||
|
||||
# {{PROJECT_NAME}}
|
||||
|
||||
{{BADGE_SECTION}}
|
||||
|
||||
{{PROJECT_DESCRIPTION}}
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
{{STRUCTURE}}
|
||||
```
|
||||
|
||||
## 子项目
|
||||
|
||||
| 项目 | 路径 | 说明 | 状态 |
|
||||
|------|------|------|------|
|
||||
{{SUBPROJECTS_TABLE}}
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 环境要求
|
||||
|
||||
{{REQUIREMENTS}}
|
||||
|
||||
### 克隆仓库
|
||||
|
||||
```bash
|
||||
{{CLONE_COMMAND}}
|
||||
```
|
||||
|
||||
### 初始化
|
||||
|
||||
```bash
|
||||
{{INIT_COMMAND}}
|
||||
```
|
||||
|
||||
## 各子项目介绍
|
||||
|
||||
### {{SUBPROJECT_1_NAME}}
|
||||
|
||||
{{SUBPROJECT_1_DESCRIPTION}}
|
||||
|
||||
**快速开始**：
|
||||
|
||||
```bash
|
||||
{{SUBPROJECT_1_QUICKSTART}}
|
||||
```
|
||||
|
||||
[详细文档]({{SUBPROJECT_1_README}})
|
||||
|
||||
### {{SUBPROJECT_2_NAME}}
|
||||
|
||||
{{SUBPROJECT_2_DESCRIPTION}}
|
||||
|
||||
**快速开始**：
|
||||
|
||||
```bash
|
||||
{{SUBPROJECT_2_QUICKSTART}}
|
||||
```
|
||||
|
||||
[详细文档]({{SUBPROJECT_2_README}})
|
||||
|
||||
<!-- 根据实际子项目数量添加更多 -->
|
||||
|
||||
## 开发指南
|
||||
|
||||
### 依赖管理
|
||||
|
||||
{{DEPENDENCY_MANAGEMENT}}
|
||||
|
||||
### 构建所有项目
|
||||
|
||||
```bash
|
||||
{{BUILD_ALL}}
|
||||
```
|
||||
|
||||
### 测试所有项目
|
||||
|
||||
```bash
|
||||
{{TEST_ALL}}
|
||||
```
|
||||
|
||||
### 发布流程
|
||||
|
||||
{{RELEASE_PROCESS}}
|
||||
|
||||
## 贡献
|
||||
|
||||
请查看 [贡献指南](CONTRIBUTING.md)。
|
||||
|
||||
## 许可证
|
||||
|
||||
{{LICENSE}}
|
||||
|
||||
各子项目可能有独立的许可证，详见各项目目录。
|
||||
165
aide-marketplace/aide-plugin/skills/rework/SKILL.md
Normal file
165
aide-marketplace/aide-plugin/skills/rework/SKILL.md
Normal file
@@ -0,0 +1,165 @@
|
||||
# 返工流程指南
|
||||
|
||||
本指南帮助你在 Aide 工作流中处理返工（rework）场景。返工是指用户在 confirm 阶段发现问题或有新需求，需要回退到之前的阶段重新处理。
|
||||
|
||||
## 返工类型判断
|
||||
|
||||
根据问题类型选择返工目标阶段：
|
||||
|
||||
| 返工目标 | 触发条件 | 处理方式 |
|
||||
|----------|----------|----------|
|
||||
| task-optimize | 新需求、需求理解偏差 | 更新 task.source |
|
||||
| flow-design | 架构/流程设计问题 | 更新细则 + new-requirements.md |
|
||||
| impl | 实现问题 | 更新细则 + new-requirements.md |
|
||||
| verify | 验证未通过 | 更新细则 + new-requirements.md |
|
||||
|
||||
---
|
||||
|
||||
## 返工到 task-optimize 阶段
|
||||
|
||||
当需要重新理解需求或有重大新需求时使用。
|
||||
|
||||
### 流程
|
||||
|
||||
1. 记录问题：
|
||||
```bash
|
||||
aide flow issue "准备返工: [原因简述]"
|
||||
```
|
||||
|
||||
2. 更新 task.source 文档（见下方格式）
|
||||
|
||||
3. 向用户发出提醒（见下方模板）
|
||||
|
||||
4. 执行返工命令：
|
||||
```bash
|
||||
aide flow back-part task-optimize "[原因]"
|
||||
```
|
||||
|
||||
5. 执行确认命令：
|
||||
```bash
|
||||
aide flow back-confirm --key [key]
|
||||
```
|
||||
> 注：key 由 `aide flow back-part` 生成
|
||||
|
||||
### task.source 更新格式
|
||||
|
||||
在文档末尾添加：
|
||||
|
||||
```markdown
|
||||
---
|
||||
|
||||
## 返工记录 [时间戳]
|
||||
|
||||
### 用户反馈
|
||||
[用户原文]
|
||||
|
||||
### 提出时机
|
||||
[在哪个阶段/步骤提出]
|
||||
|
||||
### LLM 建议
|
||||
[如有]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 返工到其他阶段
|
||||
|
||||
返工到 flow-design、impl、verify 阶段时使用。
|
||||
|
||||
### 流程
|
||||
|
||||
1. 记录问题：
|
||||
```bash
|
||||
aide flow issue "准备返工前处理需求整合: [原因简述]"
|
||||
```
|
||||
|
||||
2. 创建/更新 new-requirements.md（见下方格式）
|
||||
|
||||
3. 更新细则文档：
|
||||
- 在导览部分添加返工声明
|
||||
- 梳理：已完成项、未完成项、需重新处理项
|
||||
- 处理需求冲突
|
||||
- 融入新需求
|
||||
- 删除返工声明
|
||||
|
||||
4. 向用户发出提醒（见下方模板）
|
||||
|
||||
5. 执行返工命令：
|
||||
```bash
|
||||
aide flow back-part [阶段] "[原因]"
|
||||
```
|
||||
|
||||
6. 执行确认命令：
|
||||
```bash
|
||||
aide flow back-confirm --key [key]
|
||||
```
|
||||
|
||||
### new-requirements.md 格式
|
||||
|
||||
位置：`.aide/new-requirements.md`
|
||||
|
||||
```markdown
|
||||
# 新需求记录
|
||||
|
||||
## 返工 [时间戳]
|
||||
|
||||
### 用户反馈
|
||||
[原文]
|
||||
|
||||
### 提出时机
|
||||
[阶段/步骤]
|
||||
|
||||
### 影响分析
|
||||
- 已完成项：[列表]
|
||||
- 未完成项：[列表]
|
||||
- 需重新处理：[列表]
|
||||
|
||||
### 冲突处理
|
||||
[如何处理与原细则的冲突]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 提醒用户模板
|
||||
|
||||
### 返工到 task-optimize
|
||||
|
||||
> 我将会对 task-now.md 进行更新，加入您的新需求和我的建议，然后更新流程状态返工到 task-optimize 阶段。建议您在流程状态返工后使用 `/exit` 结束本次对话，重新启动一个新的对话执行 load+run，我将会自动接续任务的处理。
|
||||
|
||||
### 返工到其他阶段
|
||||
|
||||
> 我将会对 new-requirements.md 进行更新，加入您的新需求和我的建议，然后处理好您的新需求和原细则的需求冲突整合，然后更新流程状态返工到 [阶段] 阶段。建议您在流程状态返工后使用 `/exit` 结束本次对话，重新启动一个新的对话执行 load+run，我将会自动接续任务的处理。
|
||||
|
||||
---
|
||||
|
||||
## 确认机制
|
||||
|
||||
返工前必须完成确认流程：
|
||||
|
||||
1. 当执行 `aide flow back-part` 时，系统会检测是否已确认
|
||||
2. 如未确认，系统会生成一个随机 key 并输出提示
|
||||
3. 完成准备工作后，执行 `aide flow back-confirm --key <key>` 确认
|
||||
4. 确认成功后，系统会自动执行返工操作并创建清洁提交
|
||||
|
||||
### 命令说明
|
||||
|
||||
```bash
|
||||
# 首次调用：生成 key，记录目标阶段
|
||||
aide flow back-part flow-design "设计遗漏"
|
||||
# 输出: ⚠ 返工需要确认。请先完成准备工作，然后执行:
|
||||
# aide flow back-confirm --key abc123
|
||||
|
||||
# 完成准备后：确认并执行
|
||||
aide flow back-confirm --key abc123
|
||||
# 输出: ✓ 返工确认成功，回退到环节: flow-design
|
||||
# ⚠ 建议执行 /exit 重新开始对话
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. **文档优先**：返工前必须更新相关文档，确保上下文不丢失
|
||||
2. **清洁提交**：确认后系统会自动创建 git 提交，保留当前状态
|
||||
3. **重启对话**：建议返工后重启对话，避免上下文混乱
|
||||
4. **状态文件**：确认状态存储在 `.aide/back-confirm-state.json`
|
||||
Reference in New Issue
Block a user