diff --git a/.aide/project-docs/README.md b/.aide/project-docs/README.md index 4192fa7..7a578af 100644 --- a/.aide/project-docs/README.md +++ b/.aide/project-docs/README.md @@ -1,18 +1,18 @@ -# ccoptimize 项目文档 +# agent-aide 项目文档 -> 最后更新:2025-12-18 +> 最后更新:2025-12-19 ## 项目概述 -**ccoptimize** 是 Aide 工作流工具优化项目,包含 Aide 命令行工具的核心实现和 Claude Code 插件。 +**agent-aide** 是 Aide 工作流工具项目,包含 Aide 命令行工具的核心实现和 Claude Code 插件。 ### 项目统计 | 指标 | 数值 | |------|------| -| 总文件数 | 139(排除忽略项) | -| 总目录数 | 47(含 5 个空目录) | -| 代码行数 | 约 21000 行 | +| 总文件数 | 161(排除忽略项) | +| 总目录数 | 54(含 3 个空目录) | +| 代码行数 | 约 5350 行(Python) | | 主要语言 | Python | | 被忽略项 | 7 个目录 | @@ -23,7 +23,7 @@ | 区块 | 路径 | 文档 | 说明 | |------|------|------|------| | aide-program | `aide-program/` | [查看](blocks/aide-program.md) | 核心命令行工具实现 | -| aide-marketplace | `aide-marketplace/` | [查看](blocks/aide-marketplace.md) | 插件市场和 aide-plugin | +| aide-marketplace | `aide-marketplace/` | [查看](blocks/aide-marketplace.md) | 插件市场和 aide-plugin(版本 2.1.3) | | 项目配置与文档 | `.aide/`, `docs/` 等 | [查看](blocks/project-config-docs.md) | 配置文件和项目文档 | ## 快速导航 @@ -35,29 +35,30 @@ | 环境检测 | `aide-program/aide/env/` | 检测 Python/Node/Rust 等环境 | | 流程追踪 | `aide-program/aide/flow/` | 任务状态管理和 Git 集成 | | 待定项确认 | `aide-program/aide/decide/` | Web 界面交互式决策 | -| 斜杠命令 | `aide-marketplace/aide-plugin/commands/` | `/aide:run` 等命令定义 | -| 技能定义 | `aide-marketplace/aide-plugin/skills/` | aide、env-config、task-parser | +| 斜杠命令 | `aide-marketplace/aide-plugin/commands/` | 8 个命令定义 | +| 技能定义 | `aide-marketplace/aide-plugin/skills/` | 5 个技能定义 | ### 按文件类型 | 类型 | 数量 | 位置 | |------|------|------| | Python 源码 | ~35 | `aide-program/aide/` | -| Markdown 命令 | 4 | `aide-marketplace/aide-plugin/commands/` | -| Markdown 技能 | 3 | `aide-marketplace/aide-plugin/skills/` | +| Markdown 命令 | 8 | `aide-marketplace/aide-plugin/commands/` | +| Markdown 技能 | 5 | `aide-marketplace/aide-plugin/skills/` | | 配置文件 | ~5 | `.aide/`, 根目录 | -| 文档 | ~15 | `docs/`, `aide-program/docs/` | +| 文档 | ~15 | `docs/reference/`, `aide-program/docs/` | ## 目录结构 ``` -ccoptimize/ +agent-aide/ ├── .aide/ 项目级 Aide 配置 │ ├── config.toml 配置文件 │ ├── branches.json 分支概况数据 │ ├── branches.md 分支概况文档 -│ ├── pending-items.json 待定项数据 -│ ├── diagrams/ PlantUML 流程图 +│ ├── decisions/ [空目录] 决策记录 +│ ├── diagrams/ [空目录] PlantUML 流程图 +│ ├── task-plans/ [空目录] 复杂任务计划 │ ├── logs/ 历史任务归档 │ └── project-docs/ 本文档目录 ├── aide-program/ 核心程序(~72 文件) @@ -69,19 +70,14 @@ ccoptimize/ │ ├── bin/ 可执行脚本 │ ├── docs/ 程序文档 │ └── lib/ 依赖库 -├── aide-marketplace/ 插件市场(~21 文件) +├── aide-marketplace/ 插件市场(~39 文件) │ ├── .claude-plugin/ 市场配置 -│ └── aide-plugin/ Aide 插件(版本 2.1.0) -│ ├── commands/ 斜杠命令 -│ ├── skills/ 技能定义 +│ └── aide-plugin/ Aide 插件(版本 2.1.3) +│ ├── commands/ 斜杠命令(8 个) +│ ├── skills/ 技能定义(5 个) │ └── docs/ 插件文档 ├── docs/ 项目文档 -│ ├── aide-overview.md 系统概述 -│ ├── project-details.md 详细说明 -│ └── 01-04 指南系列 Claude Code 指南 -├── statements/ [空目录] 声明文档 -├── discuss/ [空目录] 讨论记录 -├── reply/ [空目录] 回复记录 +│ └── reference/ 参考文档(7 个) ├── CLAUDE.md Claude 配置指令 ├── CHANGELOG.md 变更日志 ├── README.md 项目说明 @@ -105,6 +101,19 @@ Aide 是一套面向 LLM 驱动开发的工作流工具,核心设计原则: | Commands | 定义流程和步骤 | `/aide:run` 定义任务执行流程 | | Skills | 提供工具使用指南 | `aide` skill 提供 CLI 命令用法 | +### 命令清单 + +| 命令 | 说明 | +|------|------| +| `/aide:setup` | 环境配置(分析、检测、修复) | +| `/aide:load` | 项目认知载入 | +| `/aide:docs` | 项目文档创建和维护 | +| `/aide:run` | 任务执行(核心命令) | +| `/aide:auto-run` | 全自动任务执行 | +| `/aide:readme` | README 生成 | +| `/aide:user-docs` | 用户文档生成 | +| `/aide:user-graph` | 用户流程图生成 | + ### 环境检测模块 | 类型 | 模块 | 说明 | @@ -118,9 +127,7 @@ Aide 是一套面向 LLM 驱动开发的工作流工具,核心设计原则: |------|------| | `.aide/decisions/` | 待定项决策记录 | | `.aide/diagrams/` | PlantUML 流程图 | -| `discuss/` | 项目讨论记录 | -| `reply/` | 项目回复记录 | -| `statements/` | 声明文档 | +| `.aide/task-plans/` | 复杂任务计划文档 | ## 被忽略项 diff --git a/.aide/project-docs/block-plan.md b/.aide/project-docs/block-plan.md index 43a01f6..0f824fd 100644 --- a/.aide/project-docs/block-plan.md +++ b/.aide/project-docs/block-plan.md @@ -1,31 +1,32 @@ # 区块计划 -> 最后更新:2025-12-18 +> 最后更新:2025-12-19 ## 项目概况 -- 项目名称:ccoptimize(Aide 工作流工具优化项目) +- 项目名称:agent-aide(Aide 工作流工具项目) - 主要语言:Python -- 总文件数:139(排除忽略项) -- 总目录数:47(含 5 个空目录) +- 总文件数:161(排除忽略项) +- 总目录数:54(含 3 个空目录) - 被忽略项:7 个目录 -- 代码行数:约 21000 行 +- 代码行数:约 5350 行(Python) ## 完整目录树(简化版 - 前两层) ``` -ccoptimize/ +agent-aide/ ├── .aide/ Aide 配置和数据目录 │ ├── config.toml 项目配置文件 │ ├── branches.json 分支概况数据 │ ├── branches.md 分支概况文档 -│ ├── pending-items.json 待定项数据 -│ ├── diagrams/ 流程图目录(含 .puml 和 .png) +│ ├── decisions/ [空目录] 待定项决策记录 +│ ├── diagrams/ [空目录] PlantUML 流程图 +│ ├── task-plans/ [空目录] 复杂任务计划文档 │ ├── logs/ 历史任务归档 │ └── project-docs/ 项目文档目录(本文档所在) ├── aide-marketplace/ Aide 插件市场 -│ ├── .claude-plugin/ 插件市场配置 -│ └── aide-plugin/ Aide 插件源码(版本 2.1.0) +│ ├── .claude-plugin/ 市场配置 +│ └── aide-plugin/ Aide 插件源码(版本 2.1.3) ├── aide-program/ Aide 主程序 │ ├── aide/ Python 源码目录 │ ├── bin/ 可执行脚本 @@ -35,22 +36,13 @@ ccoptimize/ │ ├── requirements.txt 依赖清单 │ └── .gitignore 忽略规则 ├── anthropic-agent-skills/ [ignored] Anthropic Agent Skills(第三方) -├── cache/ [ignored] 缓存目录 +├── cache/ 临时缓存目录 ├── .cache/ [ignored] 隐藏缓存目录 ├── test-cache/ [ignored] 测试缓存目录 ├── .venv/ [ignored] 根目录虚拟环境 ├── __pycache__/ [ignored] Python 字节码缓存 -├── discuss/ [空目录] 讨论文档目录 ├── docs/ 项目文档目录 -│ ├── 01-自定义斜杠命令指南.md -│ ├── 02-技能指南.md -│ ├── 03-插件指南.md -│ ├── 04-插件市场指南.md -│ ├── aide-overview.md -│ ├── project-details.md -│ └── 为什么要更换到command+skill+专用处理程序.md -├── reply/ [空目录] 回复目录 -├── statements/ [空目录] 声明文档目录 +│ └── reference/ 参考文档(7 个文件) ├── AGENTS.md Agent 配置说明 ├── CHANGELOG.md 变更日志 ├── CLAUDE.md Claude 配置指令 @@ -79,29 +71,29 @@ ccoptimize/ ### 区块 2:aide-marketplace(插件市场) - **路径**:`aide-marketplace/` -- **文件数**:约 21 个文件 +- **文件数**:约 39 个文件 - **空目录**:0 个 - **状态**:已完成 -- **说明**:Aide 插件市场和 aide-plugin 源码(版本 2.1.0),包括: +- **说明**:Aide 插件市场和 aide-plugin 源码(版本 2.1.3),包括: - `.claude-plugin/` - 市场配置 - - `aide-plugin/commands/` - 斜杠命令定义 - - `aide-plugin/skills/` - 技能定义 + - `aide-plugin/commands/` - 斜杠命令定义(8 个) + - `aide-plugin/skills/` - 技能定义(5 个,含 readme-templates 和 rework) - `aide-plugin/docs/` - 插件文档 -### 区块 3:项目配置与文档(合并原区块 3 和 4) +### 区块 3:项目配置与文档 -- **路径**:`.aide/`, `docs/`, `discuss/`, `reply/`, `statements/`, 根目录配置文件 -- **文件数**:约 46 个文件 -- **空目录**:5 个(.aide/decisions/, .aide/diagrams/, discuss/, reply/, statements/) +- **路径**:`.aide/`, `docs/`, 根目录配置文件 +- **文件数**:约 50 个文件 +- **空目录**:3 个(.aide/decisions/, .aide/diagrams/, .aide/task-plans/) - **状态**:已完成 - **说明**:项目级配置、Aide 数据目录和项目文档资源,包括: - `.aide/config.toml` - 项目配置 - `.aide/branches.json/.md` - 分支概况数据 - `.aide/decisions/` - [空目录] 待定项决策记录 - `.aide/diagrams/` - [空目录] PlantUML 流程图 + - `.aide/task-plans/` - [空目录] 复杂任务计划文档 - `.aide/logs/` - 历史任务归档 - - `docs/` - 指南和概览文档 - - `discuss/`, `reply/`, `statements/` - [空目录] + - `docs/reference/` - 指南和概览文档(7 个) - 根目录 `.md` 文件 ## 被忽略项清单 @@ -109,7 +101,7 @@ ccoptimize/ | 目录 | 说明 | |------|------| | `anthropic-agent-skills/` | 第三方技能库(Git submodule) | -| `cache/` | 临时缓存目录 | +| `cache/` | 临时缓存目录(部分保留) | | `.cache/` | 隐藏缓存目录 | | `test-cache/` | 测试缓存目录 | | `.venv/` | 根目录虚拟环境 | @@ -120,5 +112,5 @@ ccoptimize/ - [x] 区块 1:aide-program - [x] 区块 2:aide-marketplace -- [x] 区块 3:项目配置与文档(合并区块 3 和 4) +- [x] 区块 3:项目配置与文档 - [x] 总导览文档生成 diff --git a/.aide/project-docs/blocks/aide-marketplace.md b/.aide/project-docs/blocks/aide-marketplace.md index c647d8a..163b14a 100644 --- a/.aide/project-docs/blocks/aide-marketplace.md +++ b/.aide/project-docs/blocks/aide-marketplace.md @@ -1,7 +1,7 @@ # aide-marketplace(插件市场) > 路径:`aide-marketplace/` -> 最后更新:2025-12-18 +> 最后更新:2025-12-19 ## 概述 @@ -15,22 +15,46 @@ aide-marketplace/ │ └── marketplace.json 市场元数据 └── aide-plugin/ Aide 插件 ├── .claude-plugin/ 插件配置 - │ └── plugin.json 插件元数据(版本 2.1.0) - ├── commands/ 斜杠命令定义 - │ ├── auto-run.md /aide:auto-run 全自动任务执行(572 行) - │ ├── docs.md /aide:docs 文档管理(400 行) - │ ├── load.md /aide:load 项目认知载入(96 行) - │ ├── run.md /aide:run 任务执行(392 行) - │ └── setup.md /aide:setup 环境配置(93 行) - ├── skills/ 技能定义 + │ └── plugin.json 插件元数据(版本 2.1.3) + ├── commands/ 斜杠命令定义(8 个) + │ ├── auto-run.md /aide:auto-run 全自动任务执行(566 行) + │ ├── docs.md /aide:docs 文档管理(402 行) + │ ├── load.md /aide:load 项目认知载入(95 行) + │ ├── readme.md /aide:readme README 生成(253 行) + │ ├── run.md /aide:run 任务执行(557 行) + │ ├── setup.md /aide:setup 环境配置(92 行) + │ ├── user-docs.md /aide:user-docs 用户文档生成(401 行) + │ └── user-graph.md /aide:user-graph 用户流程图生成(329 行) + ├── skills/ 技能定义(5 个) │ ├── aide/ 基础命令指南 - │ │ └── SKILL.md aide skill(569 行) + │ │ └── SKILL.md aide skill(603 行) │ ├── env-config/ 环境配置指南 - │ │ └── SKILL.md env-config skill(299 行) + │ │ └── SKILL.md env-config skill(298 行) + │ ├── readme-templates/ README 模板集 + │ │ ├── SKILL.md readme-templates skill(106 行) + │ │ ├── templates/ 基础模板(5 个) + │ │ │ ├── application.md 应用程序模板 + │ │ │ ├── documentation.md 文档模板 + │ │ │ ├── library.md 库模板 + │ │ │ ├── minimal.md 最小模板 + │ │ │ └── monorepo.md 多项目仓库模板 + │ │ └── modules/ 可选模块(10 个) + │ │ ├── module-api.md + │ │ ├── module-architecture.md + │ │ ├── module-changelog.md + │ │ ├── module-configuration.md + │ │ ├── module-contributing.md + │ │ ├── module-examples.md + │ │ ├── module-faq.md + │ │ ├── module-installation.md + │ │ ├── module-license.md + │ │ └── module-quickstart.md + │ ├── rework/ 返工流程指南 + │ │ └── SKILL.md rework skill(165 行) │ └── task-parser/ 口语化内容解析 - │ └── SKILL.md task-parser skill(280 行) + │ └── SKILL.md task-parser skill(279 行) └── docs/ 插件文档 - ├── README.md 设计文档导览(207 行) + ├── README.md 设计文档导览 ├── commands/ 命令文档 │ ├── docs.md │ ├── load.md @@ -48,14 +72,19 @@ aide-marketplace/ | 文件 | 类型 | 说明 | |------|------|------| | .claude-plugin/marketplace.json | 配置 | 市场元数据,定义市场名和插件列表 | -| aide-plugin/.claude-plugin/plugin.json | 配置 | 插件元数据,版本 2.1.0 | +| aide-plugin/.claude-plugin/plugin.json | 配置 | 插件元数据,版本 2.1.3 | | aide-plugin/commands/auto-run.md | Command | /aide:auto-run 全自动任务执行流程 | | aide-plugin/commands/docs.md | Command | /aide:docs 项目文档管理流程 | | aide-plugin/commands/load.md | Command | /aide:load 项目认知载入流程 | +| aide-plugin/commands/readme.md | Command | /aide:readme README 生成流程 | | aide-plugin/commands/run.md | Command | /aide:run 任务执行核心流程 | | aide-plugin/commands/setup.md | Command | /aide:setup 环境配置流程 | +| aide-plugin/commands/user-docs.md | Command | /aide:user-docs 用户文档生成流程 | +| aide-plugin/commands/user-graph.md | Command | /aide:user-graph 用户流程图生成流程 | | aide-plugin/skills/aide/SKILL.md | Skill | aide 命令使用指南 | | aide-plugin/skills/env-config/SKILL.md | Skill | 环境配置详细指南 | +| aide-plugin/skills/readme-templates/SKILL.md | Skill | README 模板选择和使用指南 | +| aide-plugin/skills/rework/SKILL.md | Skill | 返工流程处理指南 | | aide-plugin/skills/task-parser/SKILL.md | Skill | 口语化内容解析器 | | aide-plugin/docs/README.md | 文档 | 插件设计文档导览 | @@ -68,8 +97,11 @@ aide-marketplace/ | `/aide:setup` | 环境配置(分析、检测、修复) | env-config | 是 | | `/aide:load` | 项目认知载入 | aide | 否(由 run 调用) | | `/aide:docs` | 项目文档创建和维护 | aide | 是 | -| `/aide:run` | 任务执行(核心命令) | aide | 否 | +| `/aide:run` | 任务执行(核心命令) | aide, rework | 否 | | `/aide:auto-run` | 全自动任务执行 | aide, task-parser | 是 | +| `/aide:readme` | README 生成 | readme-templates | 是 | +| `/aide:user-docs` | 用户文档生成 | readme-templates | 是 | +| `/aide:user-graph` | 用户流程图生成 | - | 是 | ### /aide:run 工作流程 @@ -99,12 +131,45 @@ task-optimize → flow-design → impl → verify → docs → finish - 跳过 confirm 阶段(无需用户验收) - 错误自动处理(优先委托子代理,否则自行解决) +### /aide:readme 工作流程 + +``` +检查规范文件 → 规范引导/README生成 + │ + ├─ 不存在 → 分析项目 → 推荐模板 → 创建规范 + └─ 存在 → 读取规范 → 加载项目信息 → 生成README +``` + +### /aide:user-docs 工作流程 + +支持分步执行和接续执行: + +``` +检查计划文件 → 分析和计划/接续执行 + │ + ├─ 不存在 → 分析项目 → 规划结构 → 生成计划 + └─ 存在 → 读取进度 → 继续执行步骤 +``` + +### /aide:user-graph 工作流程 + +用户流程图生成,支持分步执行: + +``` +检查计划文件 → 分析和计划/接续执行 + │ + ├─ 不存在 → 区块划分 → 复杂度分析 → 生成计划 + └─ 存在 → 读取进度 → 继续执行步骤 +``` + ### Skills(技能) | 技能 | 触发方式 | 职责 | |------|----------|------| | aide | /aide:run 强制触发 | aide 命令基础用法 | | env-config | /aide:setup 强制触发 | 环境配置详细指南 | +| readme-templates | /aide:readme 强制触发 | README 模板选择和使用指南 | +| rework | 返工场景时触发 | 返工流程处理指南 | | task-parser | 检测到口语化内容时 | 口语化任务内容解析 | ### aide skill @@ -112,7 +177,7 @@ task-optimize → flow-design → impl → verify → docs → finish 提供 aide 命令行工具的完整使用指南,包括: - `aide env` - 环境管理(ensure/list/set) -- `aide flow` - 进度追踪(start/next-step/back-step/next-part/back-part/issue/error/status/list/show) +- `aide flow` - 进度追踪(start/next-step/back-step/next-part/back-part/back-confirm/issue/error/status/list/show) - `aide decide` - 待定项确认(submit/result) - `aide config` - 配置管理(get/set) - `aide init` - 初始化 @@ -127,6 +192,31 @@ task-optimize → flow-design → impl → verify → docs → finish - node_deps 模块详解 - 故障排除指南 +### readme-templates skill + +提供 README 模板体系: + +**基础模板**(5 个): +- `minimal.md` - 小工具/脚本 +- `library.md` - 库/SDK +- `application.md` - 应用程序 +- `documentation.md` - 文档/教程 +- `monorepo.md` - 多项目仓库 + +**可选模块**(10 个): +- quickstart、installation、examples、api、configuration +- architecture、contributing、changelog、license、faq + +### rework skill + +提供返工流程处理指南: + +- 返工类型判断(task-optimize/flow-design/impl/verify) +- task.source 更新格式 +- new-requirements.md 格式 +- 确认机制(back-part → back-confirm) +- 用户提醒模板 + ### task-parser skill 用于解析口语化任务内容: @@ -154,7 +244,7 @@ task-optimize → flow-design → impl → verify → docs → finish ```json { "name": "aide-plugin", - "version": "2.1.0", + "version": "2.1.3", "description": "Aide 工作流体系插件" } ``` @@ -170,8 +260,11 @@ task-optimize → flow-design → impl → verify → docs → finish - Commands 定义"做什么"和"按什么顺序做" - Skills 定义"怎么调用工具" -2. **版本管理**:当前版本 2.1.0 - - 2.0.8 → 2.1.0:新增 `/aide:auto-run` 全自动任务执行命令 +2. **版本管理**:当前版本 2.1.3 + - 2.1.3:新增 `/aide:readme`、`/aide:user-docs`、`/aide:user-graph` 命令,新增 `readme-templates`、`rework` 技能 + - 2.1.0:新增 `/aide:auto-run` 全自动任务执行命令 - 原 `/aide:init`、`/aide:prep`、`/aide:exec` 已重组为 `/aide:setup`、`/aide:load`、`/aide:docs`、`/aide:run` 3. **触发机制**:Skills 按需触发,避免信息过载 + +4. **分步执行支持**:`/aide:user-docs` 和 `/aide:user-graph` 支持分步执行和接续执行,适用于大型项目 diff --git a/.aide/project-docs/blocks/project-config-docs.md b/.aide/project-docs/blocks/project-config-docs.md index d418bc7..954a62a 100644 --- a/.aide/project-docs/blocks/project-config-docs.md +++ b/.aide/project-docs/blocks/project-config-docs.md @@ -1,26 +1,27 @@ # 项目配置与文档 -> 路径:`.aide/`, `docs/`, `discuss/`, `reply/`, `statements/`, 根目录配置文件 -> 最后更新:2025-12-18 +> 路径:`.aide/`, `docs/`, 根目录配置文件 +> 最后更新:2025-12-19 ## 概述 -项目级配置、Aide 数据目录和项目文档资源。包括 Aide 配置、项目说明文档、Claude Code 指南文档和开发声明。 +项目级配置、Aide 数据目录和项目文档资源。包括 Aide 配置、项目说明文档和 Claude Code 指南文档。 ## 目录结构 ``` -ccoptimize/ +agent-aide/ ├── .aide/ Aide 配置和数据目录 -│ ├── config.toml 项目配置文件(225 行,全注释) +│ ├── config.toml 项目配置文件(全注释) │ ├── branches.json 分支概况数据(JSON) │ ├── branches.md 分支概况文档(Markdown) -│ ├── pending-items.json 待定项数据 -│ ├── diagrams/ 流程图目录 -│ │ ├── *.puml PlantUML 源文件 -│ │ └── *.png 生成的图片 +│ ├── decisions/ [空目录] 待定项决策记录 +│ ├── diagrams/ [空目录] PlantUML 流程图 +│ ├── task-plans/ [空目录] 复杂任务计划文档 │ ├── logs/ 历史任务归档 -│ │ └── flow-status.*.json 归档任务文件 +│ │ ├── YYYY-MM-DDTHH-MM-SS-status.json 任务状态归档 +│ │ ├── YYYY-MM-DDTHH-MM-SS-decisions/ 决策记录归档 +│ │ └── flow-status.*.json 旧格式归档(历史) │ └── project-docs/ 项目文档(本文档所在) │ ├── README.md 总导览 │ ├── block-plan.md 区块计划 @@ -29,16 +30,19 @@ ccoptimize/ │ ├── aide-marketplace.md │ └── project-config-docs.md ├── docs/ 项目文档目录 -│ ├── aide-overview.md Aide 系统概述(136 行) -│ ├── project-details.md 项目详细说明(约 300 行) -│ ├── 01-自定义斜杠命令指南.md Claude Code 命令指南(304 行) -│ ├── 02-技能指南.md Claude Code 技能指南(约 400 行) -│ ├── 03-插件指南.md Claude Code 插件指南(约 350 行) -│ ├── 04-插件市场指南.md Claude Code 市场指南(约 320 行) -│ └── 为什么要更换到command+skill+专用处理程序.md 设计背景 -├── discuss/ [空目录] 讨论记录目录 -├── reply/ [空目录] 回复记录目录 -├── statements/ [空目录] 声明文档目录 +│ └── reference/ 参考文档 +│ ├── aide-overview.md Aide 系统概述(135 行) +│ ├── project-details.md 项目详细说明(273 行) +│ ├── 01-自定义斜杠命令指南.md Claude Code 命令指南(303 行) +│ ├── 02-技能指南.md Claude Code 技能指南(457 行) +│ ├── 03-插件指南.md Claude Code 插件指南(436 行) +│ ├── 04-插件市场指南.md Claude Code 市场指南(382 行) +│ └── 为什么要更换到command+skill+专用处理程序.md 设计背景(245 行) +├── cache/ 缓存目录 +│ ├── old-task.md 旧任务文档 +│ ├── update_docs.sh 文档更新脚本 +│ └── verify_links.sh 链接验证脚本 +├── .cache/ [ignored] 隐藏缓存目录 ├── AGENTS.md Agent 配置说明 ├── CHANGELOG.md 变更日志 ├── CLAUDE.md Claude 配置指令 @@ -55,20 +59,19 @@ ccoptimize/ | .aide/config.toml | 配置 | 项目配置,全注释自文档化 | | .aide/branches.json | 数据 | 分支概况数据(JSON 格式) | | .aide/branches.md | 文档 | 分支概况文档(Markdown 格式) | -| .aide/pending-items.json | 数据 | 待定项数据 | -| .aide/diagrams/ | 目录 | PlantUML 流程图 | +| .aide/decisions/ | 目录 | [空目录] 待定项决策记录 | +| .aide/diagrams/ | 目录 | [空目录] PlantUML 流程图 | +| .aide/task-plans/ | 目录 | [空目录] 复杂任务计划文档 | | .aide/logs/ | 目录 | 历史任务归档 | | .aide/project-docs/ | 目录 | 面向 LLM 的项目文档 | -| docs/aide-overview.md | 文档 | Aide 系统架构和设计理念 | -| docs/project-details.md | 文档 | 项目详细说明和实现状态 | -| docs/01-自定义斜杠命令指南.md | 文档 | Claude Code 斜杠命令指南 | -| docs/02-技能指南.md | 文档 | Claude Code 技能指南 | -| docs/03-插件指南.md | 文档 | Claude Code 插件指南 | -| docs/04-插件市场指南.md | 文档 | Claude Code 市场指南 | -| docs/为什么要更换...md | 文档 | 架构设计背景说明 | -| discuss/ | 目录 | [空目录] 讨论记录 | -| reply/ | 目录 | [空目录] 回复记录 | -| statements/ | 目录 | [空目录] 声明文档 | +| docs/reference/aide-overview.md | 文档 | Aide 系统架构和设计理念 | +| docs/reference/project-details.md | 文档 | 项目详细说明和实现状态 | +| docs/reference/01-自定义斜杠命令指南.md | 文档 | Claude Code 斜杠命令指南 | +| docs/reference/02-技能指南.md | 文档 | Claude Code 技能指南 | +| docs/reference/03-插件指南.md | 文档 | Claude Code 插件指南 | +| docs/reference/04-插件市场指南.md | 文档 | Claude Code 市场指南 | +| docs/reference/为什么要更换...md | 文档 | 架构设计背景说明 | +| cache/ | 目录 | 临时缓存和脚本 | | AGENTS.md | 配置 | Agent 配置说明 | | CHANGELOG.md | 文档 | 变更日志 | | CLAUDE.md | 配置 | Claude 指令(简体中文要求) | @@ -89,9 +92,10 @@ Aide 的核心配置文件,完全自文档化(所有配置项均有详细注 |--------|------| | `[general]` | 通用配置(gitignore_aide) | | `[runtime]` | 运行时要求(python_min, use_uv) | -| `[task]` | 任务文档路径(source, spec) | +| `[task]` | 任务文档路径(source, spec, plans_path) | | `[env]` | 环境检测模块配置 | -| `[docs]` | 项目文档路径配置 | +| `[docs]` | 项目文档路径配置(path, block_plan_path) | +| `[user_docs]` | 用户文档配置(readme_path, rules_path, docs_path, docs_plan_path, graph_path, graph_plan_path) | | `[flow]` | 流程追踪配置(phases, diagram_path) | | `[plantuml]` | PlantUML 配置(jar_path) | | `[decide]` | 待定项确认配置(port, bind, url, timeout) | @@ -126,7 +130,7 @@ Claude 配置指令: ## 项目文档 -### docs/aide-overview.md +### docs/reference/aide-overview.md Aide 系统概述,包含: - 系统简介和解决的问题 @@ -135,7 +139,7 @@ Aide 系统概述,包含: - 子区块索引 - 快速导航 -### docs/project-details.md +### docs/reference/project-details.md 项目详细说明,包含: - 项目架构 @@ -152,13 +156,22 @@ Claude Code 功能的完整指南系列: ## 空目录说明 -| 目录 | 用途推断 | -|------|----------| +| 目录 | 用途 | +|------|------| | .aide/decisions/ | 待定项决策记录存放目录 | | .aide/diagrams/ | PlantUML 流程图存放目录 | -| discuss/ | 项目讨论记录存放目录 | -| reply/ | 项目回复记录存放目录 | -| statements/ | 声明文档目录(历史文件已清理) | +| .aide/task-plans/ | 复杂任务计划文档目录(guide.md + spec-NN.md) | + +## 日志归档格式 + +`.aide/logs/` 目录下的归档文件: + +**新格式(当前使用)**: +- `YYYY-MM-DDTHH-MM-SS-status.json` - 任务状态归档 +- `YYYY-MM-DDTHH-MM-SS-decisions/` - 决策记录归档目录 + +**旧格式(历史兼容)**: +- `flow-status.YYYY-MM-DDTHH-MM-SS.json` - 旧版任务状态归档 ## 依赖关系 @@ -171,3 +184,4 @@ Claude Code 功能的完整指南系列: 2. **流程图**:.puml 文件会被 aide flow 自动校验和构建 3. **文档同步**:更新代码后注意同步更新 CHANGELOG.md 4. **中文要求**:遵循 CLAUDE.md 中的简体中文要求 +5. **文档结构变化**:`docs/` 下的文件已移至 `docs/reference/` 子目录 diff --git a/task-now.md b/task-now.md index e69de29..4b0dc8b 100644 --- a/task-now.md +++ b/task-now.md @@ -0,0 +1,3 @@ +现在的finish后原分支的提交信息里,分支名后的任务名里的"开始任务准备:"是哪里来的,我希望不要有这段内容,只要有后面的实际任务名就行, + +你可以执行`git lg`来快速查看历史提交, \ No newline at end of file