[aide] 保存未提交的变更
This commit is contained in:
@@ -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/` 子目录
|
||||
|
||||
Reference in New Issue
Block a user