From 0079bd5cd43633e08d3719204346d2fa51cf77c5 Mon Sep 17 00:00:00 2001 From: "sayurinana(vm)" Date: Thu, 18 Dec 2025 22:52:53 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=83=20docs:=20=E6=9A=82=E5=AD=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .aide/project-docs/README.md | 23 ++++++------- .aide/project-docs/block-plan.md | 28 ++++++++-------- .aide/project-docs/blocks/aide-marketplace.md | 33 ++++++++++++++++--- .aide/project-docs/blocks/aide-program.md | 3 -- .../blocks/project-config-docs.md | 2 ++ README.md | 12 +++---- docs/{ => reference}/01-自定义斜杠命令指南.md | 0 docs/{ => reference}/02-技能指南.md | 0 docs/{ => reference}/03-插件指南.md | 0 docs/{ => reference}/04-插件市场指南.md | 0 docs/{ => reference}/aide-overview.md | 0 docs/{ => reference}/project-details.md | 0 ...什么要更换到command+skill+专用处理程序.md | 0 task-now.md | 31 +++++++++++++++++ 14 files changed, 93 insertions(+), 39 deletions(-) rename docs/{ => reference}/01-自定义斜杠命令指南.md (100%) rename docs/{ => reference}/02-技能指南.md (100%) rename docs/{ => reference}/03-插件指南.md (100%) rename docs/{ => reference}/04-插件市场指南.md (100%) rename docs/{ => reference}/aide-overview.md (100%) rename docs/{ => reference}/project-details.md (100%) rename docs/{ => reference}/为什么要更换到command+skill+专用处理程序.md (100%) diff --git a/.aide/project-docs/README.md b/.aide/project-docs/README.md index 522284a..3fb1033 100644 --- a/.aide/project-docs/README.md +++ b/.aide/project-docs/README.md @@ -10,9 +10,9 @@ | 指标 | 数值 | |------|------| -| 总文件数 | 132（排除忽略项） | -| 总目录数 | 53（含 5 个空目录） | -| 代码行数 | 约 20082 行 | +| 总文件数 | 139（排除忽略项） | +| 总目录数 | 47（含 5 个空目录） | +| 代码行数 | 约 21000 行 | | 主要语言 | Python | | 被忽略项 | 7 个目录 | @@ -60,7 +60,7 @@ ccoptimize/ │ ├── diagrams/ PlantUML 流程图 │ ├── logs/ 历史任务归档 │ └── project-docs/ 本文档目录 -├── aide-program/ 核心程序（~55 文件） +├── aide-program/ 核心程序（~72 文件） │ ├── aide/ Python 源码 │ │ ├── core/ 核心模块 │ │ ├── env/ 环境检测 @@ -70,10 +70,10 @@ ccoptimize/ │ ├── docs/ 程序文档 │ ├── lib/ 依赖库 │ └── offline-installer/ 离线安装器 -├── aide-marketplace/ 插件市场（~20 文件） +├── aide-marketplace/ 插件市场（~21 文件） │ ├── .claude-plugin/ 市场配置 -│ └── aide-plugin/ Aide 插件（版本 2.0.8） -│ ├── commands/ 斜杠命令（含 install-linux/win） +│ └── aide-plugin/ Aide 插件（版本 2.1.0） +│ ├── commands/ 斜杠命令（含 auto-run/install-linux/win） │ ├── skills/ 技能定义 │ └── docs/ 插件文档 ├── docs/ 项目文档 @@ -118,20 +118,21 @@ Aide 是一套面向 LLM 驱动开发的工作流工具，核心设计原则： | 目录 | 用途 | |------|------| | `.aide/decisions/` | 待定项决策记录 | -| `aide-program/.aide/decisions/` | 程序级决策记录 | -| `aide-program/.aide/logs/` | 程序级日志归档 | +| `.aide/diagrams/` | PlantUML 流程图 | | `discuss/` | 项目讨论记录 | | `reply/` | 项目回复记录 | +| `statements/` | 声明文档 | ## 被忽略项 | 目录 | 说明 | |------|------| | `anthropic-agent-skills/` | 第三方技能库 | -| `.venv/` | 虚拟环境 | +| `.venv/` | 根目录虚拟环境 | | `aide-program/.venv/` | 程序虚拟环境 | | `__pycache__/` | Python 字节码 | -| `cache/`, `.cache/`, `test-cache/` | 缓存目录 | +| `cache/`, `.cache/` | 缓存目录 | +| `test-cache/` | 测试缓存目录 | ## 使用指南 diff --git a/.aide/project-docs/block-plan.md b/.aide/project-docs/block-plan.md index 3fbb80e..e737a82 100644 --- a/.aide/project-docs/block-plan.md +++ b/.aide/project-docs/block-plan.md @@ -6,10 +6,10 @@ - 项目名称：ccoptimize（Aide 工作流工具优化项目） - 主要语言：Python -- 总文件数：132（排除忽略项） -- 总目录数：53（含 5 个空目录） +- 总文件数：139（排除忽略项） +- 总目录数：47（含 5 个空目录） - 被忽略项：7 个目录 -- 代码行数：约 20082 行 +- 代码行数：约 21000 行 ## 完整目录树（简化版 - 前两层） @@ -25,9 +25,8 @@ ccoptimize/ │ └── project-docs/ 项目文档目录（本文档所在） ├── aide-marketplace/ Aide 插件市场 │ ├── .claude-plugin/ 插件市场配置 -│ └── aide-plugin/ Aide 插件源码（版本 2.0.8） +│ └── aide-plugin/ Aide 插件源码（版本 2.1.0） ├── aide-program/ Aide 主程序 -│ ├── .aide/ 程序级配置 │ ├── aide/ Python 源码目录 │ ├── bin/ 可执行脚本 │ ├── docs/ 程序文档 @@ -67,8 +66,8 @@ ccoptimize/ ### 区块 1：aide-program（核心程序） - **路径**：`aide-program/` -- **文件数**：约 55 个源码文件 -- **空目录**：2 个（decisions/, logs/） +- **文件数**：约 72 个文件（排除 .venv 和 __pycache__） +- **空目录**：0 个 - **状态**：已完成 - **说明**：Aide 命令行工具的核心实现，包括： - `aide/core/` - 核心功能模块（配置、输出） @@ -82,26 +81,27 @@ ccoptimize/ ### 区块 2：aide-marketplace（插件市场） - **路径**：`aide-marketplace/` -- **文件数**：约 20 个文件 +- **文件数**：约 21 个文件 - **空目录**：0 个 - **状态**：已完成 -- **说明**：Aide 插件市场和 aide-plugin 源码（版本 2.0.8），包括： +- **说明**：Aide 插件市场和 aide-plugin 源码（版本 2.1.0），包括： - `.claude-plugin/` - 市场配置 - - `aide-plugin/commands/` - 斜杠命令定义（含 install-linux、install-win） + - `aide-plugin/commands/` - 斜杠命令定义（含 auto-run、install-linux、install-win） - `aide-plugin/skills/` - 技能定义 - `aide-plugin/docs/` - 插件文档 ### 区块 3：项目配置与文档（合并原区块 3 和 4） - **路径**：`.aide/`, `docs/`, `discuss/`, `reply/`, `statements/`, 根目录配置文件 -- **文件数**：约 25 个文件 -- **空目录**：3 个（discuss/, reply/, statements/） +- **文件数**：约 46 个文件 +- **空目录**：5 个（.aide/decisions/, .aide/diagrams/, discuss/, reply/, statements/） - **状态**：已完成 - **说明**：项目级配置、Aide 数据目录和项目文档资源，包括： - `.aide/config.toml` - 项目配置 - `.aide/branches.json/.md` - 分支概况数据 - - `.aide/pending-items.json` - 待定项数据 - - `.aide/diagrams/` - 流程图 + - `.aide/decisions/` - [空目录] 待定项决策记录 + - `.aide/diagrams/` - [空目录] PlantUML 流程图 + - `.aide/logs/` - 历史任务归档 - `docs/` - 指南和概览文档 - `discuss/`, `reply/`, `statements/` - [空目录] - 根目录 `.md` 文件 diff --git a/.aide/project-docs/blocks/aide-marketplace.md b/.aide/project-docs/blocks/aide-marketplace.md index 00432be..3f4be48 100644 --- a/.aide/project-docs/blocks/aide-marketplace.md +++ b/.aide/project-docs/blocks/aide-marketplace.md @@ -15,8 +15,9 @@ aide-marketplace/ │ └── marketplace.json 市场元数据 └── aide-plugin/ Aide 插件 ├── .claude-plugin/ 插件配置 - │ └── plugin.json 插件元数据（版本 2.0.8） + │ └── plugin.json 插件元数据（版本 2.1.0） ├── commands/ 斜杠命令定义 + │ ├── auto-run.md /aide:auto-run 全自动任务执行（572 行） │ ├── docs.md /aide:docs 文档管理（400 行） │ ├── install-linux.md /aide:install-linux Linux 环境安装（692 行） │ ├── install-win.md /aide:install-win Windows 环境安装 @@ -49,7 +50,8 @@ aide-marketplace/ | 文件 | 类型 | 说明 | |------|------|------| | .claude-plugin/marketplace.json | 配置 | 市场元数据，定义市场名和插件列表 | -| aide-plugin/.claude-plugin/plugin.json | 配置 | 插件元数据，版本 2.0.8 | +| aide-plugin/.claude-plugin/plugin.json | 配置 | 插件元数据，版本 2.1.0 | +| aide-plugin/commands/auto-run.md | Command | /aide:auto-run 全自动任务执行流程 | | aide-plugin/commands/docs.md | Command | /aide:docs 项目文档管理流程 | | aide-plugin/commands/install-linux.md | Command | /aide:install-linux Linux 环境安装流程 | | aide-plugin/commands/install-win.md | Command | /aide:install-win Windows 环境安装流程 | @@ -73,11 +75,12 @@ aide-marketplace/ | `/aide:load` | 项目认知载入 | aide | 否（由 run 调用） | | `/aide:docs` | 项目文档创建和维护 | aide | 是 | | `/aide:run` | 任务执行（核心命令） | aide | 否 | +| `/aide:auto-run` | 全自动任务执行 | aide, task-parser | 是 | ### /aide:run 工作流程 ``` -task-optimize → flow-design → impl → verify → docs → finish +task-optimize → flow-design → impl → verify → docs → confirm → finish │ │ ├─ 任务分析 ├─ 流程图设计 ├─ 复杂度评估 └─ PlantUML 校验 @@ -85,6 +88,23 @@ task-optimize → flow-design → impl → verify → docs → finish └─ 生成任务细则 ``` +### /aide:auto-run 工作流程 + +`/aide:run` 的自动化版本，去除所有需要用户参与的环节： + +``` +task-optimize → flow-design → impl → verify → docs → finish + │ │ + ├─ 待定项自动决策 └─ 跳过 confirm 阶段 + └─ 任务细则自动确认 +``` + +**与 /aide:run 的区别**： +- 待定项自动决策（无需用户 Web 确认） +- 任务细则自动确认（无需用户确认） +- 跳过 confirm 阶段（无需用户验收） +- 错误自动处理（优先委托子代理，否则自行解决） + ### Skills（技能） | 技能 | 触发方式 | 职责 | @@ -140,7 +160,7 @@ task-optimize → flow-design → impl → verify → docs → finish ```json { "name": "aide-plugin", - "version": "2.0.8", + "version": "2.1.0", "description": "Aide 工作流体系插件" } ``` @@ -156,6 +176,9 @@ task-optimize → flow-design → impl → verify → docs → finish - Commands 定义"做什么"和"按什么顺序做" - Skills 定义"怎么调用工具" -2. **版本管理**：当前版本 2.0.8，原 `/aide:init`、`/aide:prep`、`/aide:exec` 已重组为 `/aide:setup`、`/aide:load`、`/aide:docs`、`/aide:run`，并新增 `/aide:install-linux`、`/aide:install-win` 环境安装命令 +2. **版本管理**：当前版本 2.1.0 + - 2.0.8 → 2.1.0：新增 `/aide:auto-run` 全自动任务执行命令 + - 原 `/aide:init`、`/aide:prep`、`/aide:exec` 已重组为 `/aide:setup`、`/aide:load`、`/aide:docs`、`/aide:run` + - 新增 `/aide:install-linux`、`/aide:install-win` 环境安装命令 3. **触发机制**：Skills 按需触发，避免信息过载 diff --git a/.aide/project-docs/blocks/aide-program.md b/.aide/project-docs/blocks/aide-program.md index 73f2ef1..c6010cd 100644 --- a/.aide/project-docs/blocks/aide-program.md +++ b/.aide/project-docs/blocks/aide-program.md @@ -11,9 +11,6 @@ Aide 命令行工具的核心实现，提供环境检测、流程追踪、待定 ``` aide-program/ -├── .aide/ 程序级 Aide 配置 -│ ├── config.toml 配置文件 -│ └── decisions/ [空目录] 决策记录 ├── aide/ Python 源码包 │ ├── __init__.py 包入口（docstring） │ ├── __main__.py 模块入口 diff --git a/.aide/project-docs/blocks/project-config-docs.md b/.aide/project-docs/blocks/project-config-docs.md index eca22eb..d418bc7 100644 --- a/.aide/project-docs/blocks/project-config-docs.md +++ b/.aide/project-docs/blocks/project-config-docs.md @@ -154,6 +154,8 @@ Claude Code 功能的完整指南系列： | 目录 | 用途推断 | |------|----------| +| .aide/decisions/ | 待定项决策记录存放目录 | +| .aide/diagrams/ | PlantUML 流程图存放目录 | | discuss/ | 项目讨论记录存放目录 | | reply/ | 项目回复记录存放目录 | | statements/ | 声明文档目录（历史文件已清理） | diff --git a/README.md b/README.md index c15bf05..1ac7c28 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ aide env ensure --runtime ``` /aide:run # 执行任务（核心命令） /aide:setup # 环境配置 -/aide:docs # 项目文档管理 +/aide:docs/reference # 项目文档管理 ``` ## 核心功能 @@ -81,7 +81,7 @@ aide env ensure --runtime |------|------| | `/aide:run` | 任务执行（核心命令），整合任务准备和执行流程 | | `/aide:setup` | 环境配置，检测和修复开发环境 | -| `/aide:docs` | 项目文档创建和维护 | +| `/aide:docs/reference` | 项目文档创建和维护 | | `/aide:load` | 项目认知载入（由 run 内部调用） | ## aide 命令行工具 @@ -100,10 +100,10 @@ aide decide result # 获取决策结果 ## 文档 -- [项目详细说明](docs/project-details.md) - 项目架构和实现状态 -- [Aide 系统概述](docs/aide-overview.md) - 系统设计理念 -- [aide-plugin 文档](aide-marketplace/aide-plugin/docs/README.md) - 插件设计 -- [aide-program 文档](aide-program/docs/README.md) - 命令行工具设计 +- [项目详细说明](docs/reference/project-details.md) - 项目架构和实现状态 +- [Aide 系统概述](docs/reference/aide-overview.md) - 系统设计理念 +- [aide-plugin 文档](aide-marketplace/aide-plugin/docs/reference/README.md) - 插件设计 +- [aide-program 文档](aide-program/docs/reference/README.md) - 命令行工具设计 ## 许可证 diff --git a/docs/01-自定义斜杠命令指南.md b/docs/reference/01-自定义斜杠命令指南.md similarity index 100% rename from docs/01-自定义斜杠命令指南.md rename to docs/reference/01-自定义斜杠命令指南.md diff --git a/docs/02-技能指南.md b/docs/reference/02-技能指南.md similarity index 100% rename from docs/02-技能指南.md rename to docs/reference/02-技能指南.md diff --git a/docs/03-插件指南.md b/docs/reference/03-插件指南.md similarity index 100% rename from docs/03-插件指南.md rename to docs/reference/03-插件指南.md diff --git a/docs/04-插件市场指南.md b/docs/reference/04-插件市场指南.md similarity index 100% rename from docs/04-插件市场指南.md rename to docs/reference/04-插件市场指南.md diff --git a/docs/aide-overview.md b/docs/reference/aide-overview.md similarity index 100% rename from docs/aide-overview.md rename to docs/reference/aide-overview.md diff --git a/docs/project-details.md b/docs/reference/project-details.md similarity index 100% rename from docs/project-details.md rename to docs/reference/project-details.md diff --git a/docs/为什么要更换到command+skill+专用处理程序.md b/docs/reference/为什么要更换到command+skill+专用处理程序.md similarity index 100% rename from docs/为什么要更换到command+skill+专用处理程序.md rename to docs/reference/为什么要更换到command+skill+专用处理程序.md diff --git a/task-now.md b/task-now.md index e69de29..25b88b6 100644 --- a/task-now.md +++ b/task-now.md @@ -0,0 +1,31 @@ +对现有的 commands & skills & aide program 体系做一些调整： + +1. 把init时的gitignore_aide默认值设为false + +2. 我希望aide init能在任意目录执行原地初始化，像git init那样，不论其所处目录是否已经是.aide管理的工作目录的其中一个子目录， + +3. 创建一个类似docs的命令，但这个新命令主要面向人类用户，尤其是目标用户很可能是从未接触过工作目录下的项目对此项目完全没有了解的陌生新人， + - 入口是README.md，细节放在docs目录（因为是面向用户而非程序，所有都不要默认放在.aide目录下，而是直接放在外面，根目录下就好）下，（README.md和docs这两个路径都要在环境配置中设置，使用时必须用aide读取路径） + - 需要单独讨论一下README应该放些什么样的东西，我想的是，在配置中指定一个`make-readme-rules.md`， + - （需要注意，上面说的README.md、docs、make-readme-rules.md都是路径值，具体配置项的命名还需要你酌情考虑） + - 然后如果当前项目不存在make-readme-rules.md，就要首先引导用户设定入口编写规范，（引导用户设定入口编写规范前，应提示用户，如果还没有对此项目运行过docs+load，建议先完成面向LLM文档的构建再重新启动对话加载项目文档后再运行此命令以便于LLM更好的分析和提供对面向用户文档的编写建议，除非这个项目真的非常非常的简单微型，然后确定完成了load或是确定不需要load后，再建议把这个制定过程作为一个完整的对话，在这次对话中专注于README文档编写规范的制定，为这项任务允许消耗全部的上下文，当任务完成之后，要使用`/exit`退出本次对话重新开始一个新的对话继续完成之前的任务） + - 制作一个skills，包含一个SKILL.md和数个README.md规范模板，（需要把这数模版的编写作为一个完整的子任务单独执行，先完成该skill再实现这个第3点的其他需求） + - 可以向用户介绍有哪些可用模板，或者提供一些可选的模块化README内容规范板块供用户自由拼搭， + - 同时应该根据当前项目的项目文档（面向LLM的由docs命令构建的项目文档）进行分析，为用户提供可参考的建议 + - 我需要你尽情发挥你的创造力和专业性，指导我，像这种面向用户的文档应该写些什么，怎么写，怎么组织分布， + - 如果是一个单纯的文档&材料类项目应该怎么处理 + - 如果是一个单一的cargo、springboot、flutter、android、vue、react等这类的单体项目应该怎么处理 + - 如果是一个项目下同时含有文档&材料和cargo等程序开发单体项目应该怎么处理 + - 如果该项目下同时含有多个单体项目，例如同时含有多个cargo lib crate、cargo bin crate、多个springboot单体服务、vue前端单体项目，又应该怎么处理 + - 这些情况之间是否应该有较明显的区分？ + - 我希望要在细节文档目录下，docs目录下创建一个专用于面向用户的长期维护的完善的流程图目录，不同于run时创建的专用于当时任务的流程图，而是供用户快速理解用， + - 如果是不含程序开发内容的项目，就制作用于引导用户如何了解项目的流程图， + - 如果含程序开发，则同时制作引导的流程图和对于该项目的流程图，程序方面的流程图参考run中的程序逻辑流图规范，要求以一整套程序开发项目为单位，编写一整套流程图，例如cargo一整个目录就是一整个项目 + - 如果同时含有多个开发项目，则要对于每一个项目都编写一套流程图， + - 一套流程图是指一整个专用于这套流程图的目录，目录下含有一个guide.puml和其他子模块的puml， + - 假设一个项目下同时含有一个cargo lib crate、一个 cargo bin crate 、一个vue项目，分别名为api-lib、api、user-interface，且假设已设定用户文档的流程图目录名为graph-guide， + - 则graph-guide目录下应该至少含有三个目录api-lib、api、user-interface，和一个文件guide.puml，且每个子目录下都至少有一个guide.puml， + - 在开始编写流程图前，应该要先根据load加载的项目文档对项目进行分析和流程图分划处理，用户文档的区块划分不同于项目文档，项目文档的要求是完完全全的深度且全面的覆盖，便于先脉络后枝叶的按需加载和检索，但用户文档要按照逻辑或业务呈现一个整体的形式为目标， + - 先按需读取项目文档知道足够对项目信息做出业务逻辑整体的区块划分，然后再深入分析其复杂度和工作量，对流程图的编写工作进行步骤计划， + - 步骤计划不一定是一个子项目一个计划，例如前面api-lib+api+ui的项目，可以分为3个整体区块，但不一定只要三步就能完成，如果api-lib过于庞大，可能即使每一次都消耗满上下文，分布工作10次也不一定能完成这一个区块的任务， + - 必须先分划好区块，然后分析具体步骤计划，编写计划进度文档然后才能开始具体的流程图设计， \ No newline at end of file