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

📃 docs: 文档更新

Browse Source
This commit is contained in:
sayurinana(vm)
2025-12-18 11:46:20 +08:00
parent 83a63046b5
commit d2882c9b99
5 changed files with 71 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
.aide/project-docs/README.md
View File

@@ -1,6 +1,6 @@
# ccoptimize 项目文档
> 最后更新：2025-12-17
> 最后更新：2025-12-18
## 项目概述
@@ -54,31 +54,33 @@
ccoptimize/
├── .aide/ 项目级 Aide 配置
│ ├── config.toml 配置文件
│ ├── flow-status.json 当前任务进度
│ ├── decisions/ [空目录] 决策记录
│ ├── branches.json 分支概况数据
│ ├── branches.md 分支概况文档
│ ├── pending-items.json 待定项数据
│ ├── diagrams/ PlantUML 流程图
│ ├── logs/ 历史任务归档
│ └── project-docs/ 本文档目录
├── aide-program/ 核心程序（~50 文件）
├── aide-program/ 核心程序（~55 文件）
│ ├── aide/ Python 源码
│ │ ├── core/ 核心模块
│ │ ├── env/ 环境检测
│ │ ├── flow/ 流程追踪
│ │ ├── flow/ 流程追踪（含分支管理）
│ │ └── decide/ 待定项确认
│ ├── bin/ 可执行脚本
│ ├── docs/ 程序文档
│ └── lib/ 依赖库
├── aide-marketplace/ 插件市场（~15 文件）
│ ├── lib/ 依赖库
│ └── offline-installer/ 离线安装器
├── aide-marketplace/ 插件市场（~20 文件）
│ ├── .claude-plugin/ 市场配置
│ └── aide-plugin/ Aide 插件
│ ├── commands/ 斜杠命令
│ └── aide-plugin/ Aide 插件（版本 2.0.8）
│ ├── commands/ 斜杠命令（含 install-linux/win）
│ ├── skills/ 技能定义
│ └── docs/ 插件文档
├── docs/ 项目文档
│ ├── aide-overview.md 系统概述
│ ├── project-details.md 详细说明
│ └── 01-04 指南系列 Claude Code 指南
├── statements/ 声明文档
├── statements/ [空目录] 声明文档
├── discuss/ [空目录] 讨论记录
├── reply/ [空目录] 回复记录
├── CLAUDE.md Claude 配置指令

58
.aide/project-docs/block-plan.md
View File

@@ -1,6 +1,6 @@
# 区块计划
> 最后更新：2025-12-17
> 最后更新：2025-12-18
## 项目概况
@@ -17,20 +17,22 @@
ccoptimize/
├── .aide/ Aide 配置和数据目录
│ ├── config.toml 项目配置文件
│ ├── decisions/ [空目录] 待定项决策记录
│ ├── branches.json 分支概况数据
│ ├── branches.md 分支概况文档
│ ├── pending-items.json 待定项数据
│ ├── diagrams/ 流程图目录（含 .puml 和 .png）
│ ├── flow-status.json 当前任务进度
│ ├── logs/ 历史任务归档
│ └── project-docs/ 项目文档目录（本文档所在）
├── aide-marketplace/ Aide 插件市场
│ ├── .claude-plugin/ 插件市场配置
│ └── aide-plugin/ Aide 插件源码
│ └── aide-plugin/ Aide 插件源码（版本 2.0.8）
├── aide-program/ Aide 主程序
│ ├── .aide/ 程序级配置
│ ├── aide/ Python 源码目录
│ ├── bin/ 可执行脚本
│ ├── docs/ 程序文档
│ ├── lib/ 依赖库（plantuml.jar）
│ ├── offline-installer/ 离线安装器
│ ├── .venv/ [ignored] 虚拟环境
│ ├── requirements.txt 依赖清单
│ └── .gitignore 忽略规则
@@ -50,9 +52,7 @@ ccoptimize/
│ ├── project-details.md
│ └── 为什么要更换到command+skill+专用处理程序.md
├── reply/ [空目录] 回复目录
├── statements/ 声明文档目录
│ ├── old-task-section.md
│ └── optimize.md
├── statements/ [空目录] 声明文档目录
├── AGENTS.md Agent 配置说明
├── CHANGELOG.md 变更日志
├── CLAUDE.md Claude 配置指令
@@ -67,52 +67,44 @@ ccoptimize/
### 区块 1：aide-program（核心程序）
- **路径**：`aide-program/`
- **文件数**：约 50 个源码文件
- **文件数**：约 55 个源码文件
- **空目录**：2 个（decisions/, logs/）
- **状态**：待处理
- **状态**：已完成
- **说明**：Aide 命令行工具的核心实现，包括：
- `aide/core/` - 核心功能模块（配置、输出）
- `aide/env/` - 环境检测模块
- `aide/flow/` - 流程追踪模块
- `aide/flow/` - 流程追踪模块（含分支管理）
- `aide/decide/` - 待定项确认模块
- `bin/` - 可执行脚本
- `docs/` - 程序文档
- `offline-installer/` - 离线安装器（Linux/Windows）
### 区块 2：aide-marketplace（插件市场）
- **路径**：`aide-marketplace/`
- **文件数**：约 15 个文件
- **文件数**：约 20 个文件
- **空目录**：0 个
- **状态**：待处理
- **说明**：Aide 插件市场和 aide-plugin 源码，包括：
- **状态**：已完成
- **说明**：Aide 插件市场和 aide-plugin 源码（版本 2.0.8），包括：
- `.claude-plugin/` - 市场配置
- `aide-plugin/commands/` - 斜杠命令定义
- `aide-plugin/commands/` - 斜杠命令定义（含 install-linux、install-win）
- `aide-plugin/skills/` - 技能定义
- `aide-plugin/docs/` - 插件文档
### 区块 3：项目配置（根目录配置）
### 区块 3：项目配置与文档（合并原区块 3 和 4）
- **路径**：`.aide/`, 根目录配置文件
- **文件数**：约 15 个文件
- **空目录**：1 个（decisions/）
- **状态**：待处理
- **说明**：项目级配置和 Aide 数据目录，包括：
- **路径**：`.aide/`, `docs/`, `discuss/`, `reply/`, `statements/`, 根目录配置文件
- **文件数**：约 25 个文件
- **空目录**：3 个（discuss/, reply/, statements/）
- **状态**：已完成
- **说明**：项目级配置、Aide 数据目录和项目文档资源，包括：
- `.aide/config.toml` - 项目配置
- `.aide/branches.json/.md` - 分支概况数据
- `.aide/pending-items.json` - 待定项数据
- `.aide/diagrams/` - 流程图
- `.aide/flow-status.json` - 任务状态
- 根目录 `.md` 文件
### 区块 4：项目文档与资源
- **路径**：`docs/`, `discuss/`, `reply/`, `statements/`
- **文件数**：约 10 个文件
- **空目录**：2 个（discuss/, reply/）
- **状态**：待处理
- **说明**：项目文档和资源文件目录，包括：
- `docs/` - 指南和概览文档
- `statements/` - 声明文档
- `discuss/` - [空目录] 讨论记录
- `reply/` - [空目录] 回复记录
- `discuss/`, `reply/`, `statements/` - [空目录]
- 根目录 `.md` 文件
## 被忽略项清单

16
.aide/project-docs/blocks/aide-marketplace.md
View File

@@ -1,7 +1,7 @@
# aide-marketplace（插件市场）
> 路径：`aide-marketplace/`
> 最后更新：2025-12-17
> 最后更新：2025-12-18
## 概述
@@ -15,9 +15,11 @@ aide-marketplace/
│ └── marketplace.json 市场元数据
└── aide-plugin/ Aide 插件
├── .claude-plugin/ 插件配置
│ └── plugin.json 插件元数据（版本 2.0.6）
│ └── plugin.json 插件元数据（版本 2.0.8）
├── commands/ 斜杠命令定义
│ ├── docs.md /aide:docs 文档管理（400 行）
│ ├── install-linux.md /aide:install-linux Linux 环境安装（692 行）
│ ├── install-win.md /aide:install-win Windows 环境安装
│ ├── load.md /aide:load 项目认知载入（96 行）
│ ├── run.md /aide:run 任务执行（392 行）
│ └── setup.md /aide:setup 环境配置（93 行）
@@ -47,8 +49,10 @@ aide-marketplace/
| 文件 | 类型 | 说明 |
|------|------|------|
| .claude-plugin/marketplace.json | 配置 | 市场元数据，定义市场名和插件列表 |
| aide-plugin/.claude-plugin/plugin.json | 配置 | 插件元数据，版本 2.0.6 |
| aide-plugin/.claude-plugin/plugin.json | 配置 | 插件元数据，版本 2.0.8 |
| 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 环境安装流程 |
| aide-plugin/commands/load.md | Command | /aide:load 项目认知载入流程 |
| aide-plugin/commands/run.md | Command | /aide:run 任务执行核心流程 |
| aide-plugin/commands/setup.md | Command | /aide:setup 环境配置流程 |
@@ -64,6 +68,8 @@ aide-marketplace/
| 命令 | 职责 | 触发 Skill | 独立运行 |
|------|------|------------|----------|
| `/aide:setup` | 环境配置（分析、检测、修复） | env-config | 是 |
| `/aide:install-linux` | Linux 环境安装 | aide | 是 |
| `/aide:install-win` | Windows 环境安装 | aide | 是 |
| `/aide:load` | 项目认知载入 | aide | 否（由 run 调用） |
| `/aide:docs` | 项目文档创建和维护 | aide | 是 |
| `/aide:run` | 任务执行（核心命令） | aide | 否 |
@@ -134,7 +140,7 @@ task-optimize → flow-design → impl → verify → docs → finish
```json
{
"name": "aide-plugin",
"version": "2.0.6",
"version": "2.0.8",
"description": "Aide 工作流体系插件"
}
```
@@ -150,6 +156,6 @@ task-optimize → flow-design → impl → verify → docs → finish
- Commands 定义"做什么"和"按什么顺序做"
- Skills 定义"怎么调用工具"
2. **版本管理**：当前版本 2.0.6，原 `/aide:init`、`/aide:prep`、`/aide:exec` 已重组为 `/aide:setup`、`/aide:load`、`/aide:docs`、`/aide:run`
2. **版本管理**：当前版本 2.0.8，原 `/aide:init`、`/aide:prep`、`/aide:exec` 已重组为 `/aide:setup`、`/aide:load`、`/aide:docs`、`/aide:run`，并新增 `/aide:install-linux`、`/aide:install-win` 环境安装命令
3. **触发机制**：Skills 按需触发，避免信息过载

16
.aide/project-docs/blocks/aide-program.md
View File

@@ -1,7 +1,7 @@
# aide-program（核心程序）
> 路径：`aide-program/`
> 最后更新：2025-12-17
> 最后更新：2025-12-18
## 概述
@@ -13,8 +13,7 @@ Aide 命令行工具的核心实现，提供环境检测、流程追踪、待定
aide-program/
├── .aide/ 程序级 Aide 配置
│ ├── config.toml 配置文件
│ ├── decisions/ [空目录] 决策记录
│ └── logs/ [空目录] 日志归档
│ └── decisions/ [空目录] 决策记录
├── aide/ Python 源码包
│ ├── __init__.py 包入口（docstring）
│ ├── __main__.py 模块入口
@@ -47,6 +46,7 @@ aide-program/
│ │ ├── storage.py 状态存储（147 行）
│ │ ├── validator.py 流程校验（55 行）
│ │ ├── git.py Git 集成（79 行）
│ │ ├── branch.py 分支管理（462 行）
│ │ ├── hooks.py 环节钩子（148 行）
│ │ ├── errors.py 错误类型（9 行）
│ │ └── utils.py 工具函数（19 行）
@@ -94,6 +94,15 @@ aide-program/
│ └── data.md 数据格式
├── lib/ 依赖库
│ └── plantuml.jar PlantUML（二进制）
├── offline-installer/ 离线安装器目录
│ ├── linux/ Linux 安装
│ │ ├── install.sh 安装脚本（470 行）
│ │ ├── README.md 安装说明
│ │ └── resources.json 资源配置
│ └── windows/ Windows 安装
│ ├── install.ps1 PowerShell 安装脚本（405 行）
│ ├── README.md 安装说明
│ └── resources.json 资源配置
├── .venv/ [ignored] 虚拟环境
├── requirements.txt Python 依赖
└── .gitignore 忽略规则
@@ -125,6 +134,7 @@ aide-program/
| aide/flow/storage.py | 源码 | 状态文件读写和归档 |
| aide/flow/validator.py | 源码 | 环节跳转校验 |
| aide/flow/git.py | 源码 | Git 操作封装 |
| aide/flow/branch.py | 源码 | 分支管理器，任务分支创建、记录、合并 |
| aide/flow/hooks.py | 源码 | PlantUML/CHANGELOG 钩子 |
| aide/flow/errors.py | 源码 | FlowError 异常类 |
| aide/flow/utils.py | 源码 | 时间戳和文本处理 |

21
.aide/project-docs/blocks/project-config-docs.md
View File

@@ -1,7 +1,7 @@
# 项目配置与文档
> 路径：`.aide/`, `docs/`, `discuss/`, `reply/`, `statements/`, 根目录配置文件
> 最后更新：2025-12-17
> 最后更新：2025-12-18
## 概述
@@ -13,8 +13,9 @@
ccoptimize/
├── .aide/ Aide 配置和数据目录
│ ├── config.toml 项目配置文件（225 行，全注释）
│ ├── flow-status.json 当前任务进度
│ ├── decisions/ [空目录] 待定项决策记录
│ ├── branches.json 分支概况数据（JSON）
│ ├── branches.md 分支概况文档（Markdown）
│ ├── pending-items.json 待定项数据
│ ├── diagrams/ 流程图目录
│ │ ├── *.puml PlantUML 源文件
│ │ └── *.png 生成的图片
@@ -37,9 +38,7 @@ ccoptimize/
│ └── 为什么要更换到command+skill+专用处理程序.md 设计背景
├── discuss/ [空目录] 讨论记录目录
├── reply/ [空目录] 回复记录目录
├── statements/ 声明文档目录
│ ├── old-task-section.md 历史任务节选
│ └── optimize.md 口头话解析准则
├── statements/ [空目录] 声明文档目录
├── AGENTS.md Agent 配置说明
├── CHANGELOG.md 变更日志
├── CLAUDE.md Claude 配置指令
@@ -54,8 +53,9 @@ ccoptimize/
| 文件 | 类型 | 说明 |
|------|------|------|
| .aide/config.toml | 配置 | 项目配置，全注释自文档化 |
| .aide/flow-status.json | 数据 | 当前任务进度状态 |
| .aide/decisions/ | 目录 | [空目录] 待定项决策记录 |
| .aide/branches.json | 数据 | 分支概况数据（JSON 格式） |
| .aide/branches.md | 文档 | 分支概况文档（Markdown 格式） |
| .aide/pending-items.json | 数据 | 待定项数据 |
| .aide/diagrams/ | 目录 | PlantUML 流程图 |
| .aide/logs/ | 目录 | 历史任务归档 |
| .aide/project-docs/ | 目录 | 面向 LLM 的项目文档 |
@@ -68,8 +68,7 @@ ccoptimize/
| docs/为什么要更换...md | 文档 | 架构设计背景说明 |
| discuss/ | 目录 | [空目录] 讨论记录 |
| reply/ | 目录 | [空目录] 回复记录 |
| statements/old-task-section.md | 文档 | 历史任务节选 |
| statements/optimize.md | 文档 | 口头话解析准则 |
| statements/ | 目录 | [空目录] 声明文档 |
| AGENTS.md | 配置 | Agent 配置说明 |
| CHANGELOG.md | 文档 | 变更日志 |
| CLAUDE.md | 配置 | Claude 指令（简体中文要求） |
@@ -157,7 +156,7 @@ Claude Code 功能的完整指南系列：
|------|----------|
| discuss/ | 项目讨论记录存放目录 |
| reply/ | 项目回复记录存放目录 |
| .aide/decisions/ | aide decide 决策记录 |
| statements/ | 声明文档目录（历史文件已清理） |
## 依赖关系