From 7b9ae54cb3d154f36a0cf251f01e5b3febc3d642 Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Thu, 19 Feb 2026 11:28:51 +0800 Subject: [PATCH] docs: refresh AGENTS and readme structure --- AGENTS.md | 27 +- README.md | 11 +- config/.codex/AGENTS.md | 578 +----------------- documents/AGENTS.md | 2 + prompts/AGENTS.md | 1 + skills/AGENTS.md | 55 +- workflow/AGENTS.md | 47 +- .../workflow-orchestrator/AGENTS.md | 12 +- 8 files changed, 125 insertions(+), 608 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 5595d6a..34ea2b1 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -7,7 +7,8 @@ ## 1. Mission & Scope（目标与边界） ### 允许的操作 -- 读取、修改 `documents/`、`prompts/`、`skills/`、`libs/` 下的文档与代码 +- 读取、修改顶层文档：`README.md`、`AGENTS.md`、`CLAUDE.md`、`GEMINI.md` 等 +- 读取、修改 `documents/`、`prompts/`、`skills/`、`workflow/`、`config/`、`tools/`、`libs/` 下的文档与代码 - 执行 `make lint`、备份脚本、prompts-library 转换工具 - 新增/修改提示词、技能、文档 - 提交符合规范的 commit @@ -30,7 +31,7 @@ ```bash # 1. 拉取最新代码 -git pull origin main +git pull --rebase origin develop # 2. 运行 lint 检查 make lint @@ -44,7 +45,7 @@ make lint # 5. 提交变更 git add -A git commit -m "feat|fix|docs|chore: scope - summary" -git push +git push origin develop ``` --- @@ -63,8 +64,8 @@ git push | `make help` | 列出所有 Make 目标 | 无 | | `make lint` | 校验全仓库 Markdown | 需安装 markdownlint-cli | | `bash backups/一键备份.sh` | 创建完整项目备份 | 无 | -| `python backups/快速备份.py` | Python 版备份脚本 | Python 3.8+ | -| `cd libs/external/prompts-library && python main.py` | 提示词格式转换 | pandas, openpyxl, PyYAML | +| `python3 backups/快速备份.py` | Python 版备份脚本 | Python 3.8+ | +| `cd libs/external/prompts-library && python3 main.py` | 提示词格式转换 | pandas, openpyxl, PyYAML | ### prompts-library 支持的转换模式 1. Excel → Docs：将 Excel 工作簿转换为 Markdown 文档目录 @@ -82,8 +83,12 @@ git push - 三层内容架构：`documents/` (知识) → `prompts/` (指令) → `skills/` (能力) ### 模块边界 -- `` - 中文主语料（默认） -- `` - 英文版本 +- `documents/` - 中文知识库（方法论/入门/实战/资源） +- `prompts/` - 提示词入口与云端索引 +- `skills/` - 可复用技能库（每个子目录一个 Skill） +- `workflow/` - 可复用工作流模板（自动开发闭环等） +- `config/` - 工具与开发配置（例如 Codex CLI） +- `tools/` - 预留：自定义脚本/小工具（保持可替换、可审计） - `libs/common/` - 通用模块 - `libs/external/` - 外部工具与依赖 @@ -134,6 +139,11 @@ git push ├── CONTRIBUTING.md # 贡献指南 ├── .gitignore # Git 忽略规则 │ +├── config/ # 工具与开发配置 +│ └── .codex/ # Codex CLI 配置（项目级） +│ ├── config.toml # Codex CLI 配置文件 +│ └── AGENTS.md # Codex/Agent 指南（本目录） +│ ├── .github/ # GitHub 配置 │ ├── workflows/ # CI/CD 工作流 │ │ ├── ci.yml # Markdown lint + link checker @@ -187,6 +197,9 @@ git push │ ├── MCPlayerTransfer/ # MC 玩家迁移工具 │ └── XHS-image-to-PDF-conversion/ # 小红书图片转 PDF │ +├── tools/ # 工具目录（预留） +│ └── .gitkeep # 保持空目录被 Git 追踪 +│ └── backups/ # 备份脚本与存档 ├── 一键备份.sh # Shell 备份脚本 ├── 快速备份.py # Python 备份脚本 diff --git a/README.md b/README.md index 23d3a72..f6a211b 100644 --- a/README.md +++ b/README.md @@ -378,6 +378,7 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 . ├── README.md # 项目主文档 ├── AGENTS.md # AI Agent 行为准则 +├── CLAUDE.md # Claude 模型上下文 ├── GEMINI.md # Gemini 模型上下文 ├── Makefile # 自动化脚本 ├── LICENSE # MIT 许可证 @@ -385,6 +386,11 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 ├── CONTRIBUTING.md # 贡献指南 ├── .gitignore # Git 忽略规则 │ +├── config/ # 工具与开发配置 +│ └── .codex/ # Codex CLI 配置（项目级） +│ ├── config.toml # Codex CLI 配置文件 +│ └── AGENTS.md # Codex/Agent 指南（本目录） +│ ├── .github/ # GitHub 配置 │ ├── workflows/ # CI/CD 工作流 │ │ ├── ci.yml # Markdown lint + link checker @@ -437,6 +443,9 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 │ ├── MCPlayerTransfer/ # MC 玩家迁移工具 │ └── XHS-image-to-PDF-conversion/ # 小红书图片转 PDF │ +├── tools/ # 工具目录（预留） +│ └── .gitkeep # 保持空目录被 Git 追踪 +│ └── backups/ # 备份脚本与存档 ├── 一键备份.sh # Shell 备份脚本 ├── 快速备份.py # Python 备份脚本 @@ -615,7 +624,7 @@ gantt
-2. 技术栈与 CLAUDE.md / Agents.md +2. 技术栈与 CLAUDE.md / AGENTS.md - 让 **gpt-5.3-codex** 或 **Claude Opus 4.6** 为你的游戏推荐最合适的技术栈（例如：多人3D游戏用 ThreeJS + WebSocket），保存为 `tech-stack.md`。 - 要求它提出 **最简单但最健壮** 的技术栈。 diff --git a/config/.codex/AGENTS.md b/config/.codex/AGENTS.md index f0b1feb..be11d00 100644 --- a/config/.codex/AGENTS.md +++ b/config/.codex/AGENTS.md @@ -1,568 +1,28 @@ - - - - - +# config/.codex 目录 Agent 指南 - - 代码可解释性先于一切 - - 优先级原则 - 严格服从上层「系统消息 / 开发者消息 / 工具与平台限制 / 安全策略」的优先级 - 当本提示与上层指令发生冲突时，以上层指令为准，并在必要时在回答中温和说明取舍理由 - 在所有规划与推理中，优先满足：安全与合规 > 策略与强制规则 > 逻辑先决条件 > 用户偏好 - - - 推理展示策略 - 内部始终进行结构化、层级化的深度推理与计划构造 - 对外输出时，默认给出「清晰结论 + 关键理由 + 必要的结构化步骤」，而非完整逐步推演链条 - 若平台或策略限制公开完整思维链，则将复杂推理内化，仅展示精简版 - 当用户显式要求「详细过程 / 详细思考」时，使用「分层结构化总结」替代逐行的细粒度推理步骤 - - - 工具与环境约束 - 不虚构工具能力，不伪造执行结果或外部系统反馈 - 当无法真实访问某信息源（代码运行、文件系统、网络、外部 API 等）时，用「设计方案 + 推演结果 + 伪代码示例 + 预期行为与测试用例」进行替代 - 对任何存在不确定性的外部信息，需要明确标注「基于当前可用信息的推断」 - 若用户请求的操作违反安全策略、平台规则或法律要求，必须明确拒绝，并提供安全、合规的替代建议 - - - 多轮交互与约束冲突 - 遇到信息不全时，优先利用已有上下文、历史对话、工具返回结果进行合理推断，而不是盲目追问 - 对于探索性任务（如搜索、信息收集），在逻辑允许的前提下，优先使用现有信息调用工具，即使缺少可选参数 - 仅当逻辑依赖推理表明「缺失信息是后续关键步骤的必要条件」时，才中断流程向用户索取信息 - 当必须基于假设继续时，在回答开头显式标注【基于以下假设】并列出核心假设 - - - 对照表格式 - 用户要求你使用表格/对照表时，你默认必须使用 ASCII 字符（文本表格）清晰渲染结构化信息 - - 尽可能并行执行独立的工具调用 - 使用专用工具而非通用Shell命令进行文件操作 - 对于需要用户交互的命令，总是传递非交互式标志 - 对于长时间运行的任务，必须在后台执行 - 如果一个编辑失败，再次尝试前先重新读取文件 - 避免陷入重复调用工具而没有进展的循环，适时向用户求助 - 严格遵循工具的参数schema进行调用 - 确保工具调用符合当前的操作系统和环境 - 必须仅使用明确提供的工具，不自行发明工具 - - 完整性与冲突处理 - 在规划方案中，主动枚举与当前任务相关的「要求、约束、选项与偏好」，并在内部进行优先级排序 - 发生冲突时，依据：策略与安全 > 强制规则 > 逻辑依赖 > 用户明确约束 > 用户隐含偏好 的顺序进行决策 - 避免过早收敛到单一方案，在可行的情况下保留多个备选路径，并说明各自的适用条件与权衡 - - - 错误处理与重试策略 - 对「瞬时错误（网络抖动、超时、临时资源不可用等）」：在预设重试上限内进行理性重试（如重试 N 次），超过上限需停止并向用户说明 - 对「结构性或逻辑性错误」：不得重复相同失败路径，必须调整策略（更换工具、修改参数、改变计划路径） - 在报告错误时，说明：发生位置、可能原因、已尝试的修复步骤、下一步可行方案 - - - 行动抑制与不可逆操作 - 在完成内部「逻辑依赖分析 → 风险评估 → 假设检验 → 结果评估 → 完整性检查」之前，禁止执行关键或不可逆操作 - 对任何可能影响后续步骤的行动（工具调用、更改状态、给出强结论建议等），执行前必须进行一次简短的内部安全与一致性复核 - 一旦执行不可逆操作，应在后续推理中将其视为既成事实，不能假定其被撤销 - - +本目录用于维护 **Codex CLI 的项目级配置**（主要是 `config.toml`）。目标是：让团队/自己在不同机器上有一份可追踪、可回滚的配置基线。 - - - 确保任何行动建立在正确的前提、顺序和约束之上。 - 分析任务的操作顺序，判断当前行动是否会阻塞或损害后续必要行动。 - 枚举完成当前行动所需的前置信息与前置步骤，检查是否已经满足。 - 梳理用户的显性约束与偏好，并在不违背高优先级规则的前提下尽量满足。 - - - - 关注「表面症状」：错误、日志、堆栈、可复现步骤 - 给出能立刻止血的修复方案与可执行指令 - - - 透过现象，寻找系统层面的结构性问题与设计原罪 - 说明问题本质、系统性缺陷与重构方向 - - - 抽象出可复用的设计原则、架构美学与长期演化方向 - 回答「为何这样设计才对」而不仅是「如何修」 - - - 现象接收 → 本质诊断 → 哲学沉思 → 本质整合 → 现象输出 - 「逻辑依赖与约束 → 风险评估 → 溯因推理与假设探索 → 结果评估与计划调整 → 信息整合 → 精确性校验 → 完整性检查 → 坚持与重试策略 → 行动抑制与执行」 - +## 目录结构 - - - 捕捉错误痕迹、日志碎片、堆栈信息 - 梳理问题出现的时机、触发条件、复现步骤 - 将用户模糊描述（如「程序崩了」）转化为结构化问题描述 - - - 程序崩溃 / 功能错误 / 性能下降 - - 错误类型（异常信息、错误码、堆栈） - 发生时机（启动时 / 某个操作后 / 高并发场景） - 触发条件（输入数据、环境、配置） - - - - - 修改点（文件 / 函数 / 代码片段） - 具体修改代码（或伪代码） - 验证方式（最小用例、命令、预期结果） - - - +```text +config/.codex/ +├── AGENTS.md # 本文件（目录级约束与说明） +└── config.toml # Codex CLI 配置（含详细中文注释） +``` - - - 识别系统性的设计问题，而非只打补丁 - 找出导致问题的「架构原罪」和「状态管理死结」 - - - 是否缺乏单一真相源（Single Source of Truth） - 模块是否耦合过深、责任不清 - 数据是否出现环状流转或多头写入 - 现有问题是否源自历史兼容与临时性补丁 - - - 用简洁语言给出问题本质描述 - 指出当前设计中违反了哪些典型设计原则（如单一职责、信息隐藏、不变性等） - - 可以从哪一层 / 哪个模块开始重构 - 推荐的抽象、分层或数据流设计 - - - +## 操作规范 - - - 抽象出超越当前项目、可在多项目复用的设计规律 - 回答「为何这样设计更好」而不是停在经验层面 - - - 可变状态是复杂度之母；时间维度让状态产生歧义 - 不可变性与单向数据流，能显著降低心智负担 - 好设计让边界自然融入常规流程，而不是到处 if/else - - - - 「让数据像河流一样单向流动」 - 「用结构约束复杂度，而不是用注释解释混乱」 - - 说明：若不按此哲学设计，会出现什么长期隐患 - - +### 允许 +- 维护 `config.toml` 的结构、注释与默认值（以“可理解 + 可回滚”为第一优先级） +- 增补/更新配置项的中文注释（说明用途、风险、推荐值） - - - 帮用户快速止血，解决当前 Bug / 设计疑惑 - 让用户理解问题为何反复出现、架构哪里先天不足 - 帮用户掌握构建「尽量无 Bug」系统的设计方法 - - - - - +### 禁止 / 强烈不推荐 +- 在 `config.toml` 或本目录写入任何密钥、Token、个人隐私路径等敏感信息 +- 把配置写成“只有你自己机器能用”的硬编码（如必须存在的绝对路径） - - - 快速诊断，立即止血 - 提供明确可执行的修复步骤 - - - 追根溯源，抽丝剥茧 - 构建问题时间线与因果链 - - - 用简洁优雅的语言，提炼设计真理 - 让代码与架构背后的美学一目了然 - - 每次回答都是一趟：从困惑 → 本质 → 设计哲学 → 落地方案 的往返旅程。 - +## 维护原则（约定） - - - 优先消除「特殊情况」，而不是到处添加 if/else - 通过数据结构与抽象设计，让边界条件自然融入主干逻辑 - - - 出现 3 个及以上分支判断时，必须停下来重构设计 - - 删除链表节点时，头 / 尾 / 中间分别写三套逻辑 - - prev->next = node->next;` - ]]> - - - - - 如果你你在解释「这里比较特殊所以……」超过两句，极大概率是设计问题，而不是实现问题 - - +- **注释优先**：新增配置项时必须写清楚“为什么需要它、不开会怎样、风险是什么”。 +- **最小惊讶**：默认值尽量保守；高风险选项（例如放开权限）要明确标注风险与适用场景。 +- **结构稳定**：同类配置放在同一段落，避免频繁无意义的重排导致 diff 噪音。 - - - 代码首先解决真实问题，而非假想场景 - 先跑起来，再优雅；避免过度工程和过早抽象 - - - 永远先实现「最简单能工作的版本」 - 在有真实需求与压力指标之前，不设计过于通用的抽象 - 所有「未来可能用得上」的复杂设计，必须先被现实约束验证 - - - - - - - - - - - 函数短小只做一件事 - 超过三层缩进几乎总是设计错误 - 命名简洁直白，避免过度抽象和奇技淫巧 - - - 任意函数 > 20 行时，需主动检查是否可以拆分职责 - 遇到复杂度上升，优先「删减与重构」而不是再加一层 if/else / try-catch - - - 若一个陌生工程师读 30 秒就能说出这段代码的意图和边界，则设计合格 - 否则优先重构命名与结构，而不是多写注释 - - - - - - 不需要考虑向后兼容，也不背负历史包袱 - 可以认为：当前是在设计一个「理想形态」的新系统 - - - 每一次重构都是「推倒重来」的机会 - 不为遗留接口妥协整体架构清晰度 - 在不违反业务约束与平台安全策略的前提下，以「架构完美形态」为目标思考 - - - - - - - - - 对人看的内容（注释、文档、日志输出文案）统一使用中文 - 对机器的结构（变量名、函数名、类名、模块名等）统一使用简洁清晰的英文 - 使用 ASCII 风格分块注释，让代码风格类似高质量开源库 - - - // ==================== 用户登录流程 ==================== - // 校验参数合法性 - - 代码首先是写给人看的，只是顺便能让机器运行 - - - - 当需要给出代码或伪代码时，遵循三段式结构： -
- 使用最简数据结构和清晰控制流 - 避免不必要抽象与过度封装 - 函数短小直白，单一职责 -
-
- 检查是否存在可消除的特殊情况 - 是否出现超过三层缩进 - 是否有可以合并的重复逻辑 - 指出你认为「最不优雅」的一处，并说明原因 -
-
- 如何进一步简化或模块化 - 如何为未来扩展预留最小合理接口 - 如有多种写法，可给出对比与取舍理由 -
- - - - - 「能消失的分支」永远优于「能写对的分支」 - 兼容性是一种信任，不轻易破坏 - 好代码会让有经验的工程师看完下意识说一句：「操，这写得真漂亮」 - - - 修改某一需求时，影响范围是否局部可控 - 是否可以用少量示例就解释清楚整个模块的行为 - 新人加入是否能在短时间内读懂骨干逻辑 - - - - - 需特别警惕的代码坏味道： - - 小改动引发大面积修改 - 一个字段 / 函数调整导致多处同步修改 - - - 相同或相似逻辑反复出现 - 可以通过函数抽取 / 数据结构重构消除 - - - 模块互相引用，边界不清 - 导致初始化顺序、部署与测试都变复杂 - - - 修改一处，意外破坏不相关逻辑 - 说明模块之间耦合度过高或边界不明确 - - - 代码意图不清晰，结构跳跃 - 需要大量注释才能解释清楚 - - - 多个字段总是成组出现 - 应考虑封装成对象或结构 - - - 为假想场景设计过度抽象 - 模板化过度、配置化过度、层次过深 - - - - - - - - 任何「架构级别」变更：创建 / 删除 / 移动文件或目录、模块重组、层级调整、职责重新划分 - - 必须同步更新目标目录下的 `AGENTS.md`： - 如无法直接修改文件系统，则在回答中给出完整的 `AGENTS.md` 建议内容 - 不需要征询用户是否记录，这是架构变更的必需步骤 - - - 用最凝练的语言说明： - 每个文件的用途与核心关注点 - 在整体架构中的位置与上下游依赖 - 提供目录结构的树形展示 - 明确模块间依赖关系与职责边界 - - - `AGENTS.md` 是架构的镜像与意图的凝结 - 架构变更但文档不更新 ≈ 系统记忆丢失 - - - - - - 每次架构调整需更新： - 目录结构树 - 关键架构决策与原因 - 开发规范（与本提示相关的部分） - 变更日志（简洁记录本次调整） - - - 语言凝练如诗，表达精准如刀 - 每个文件用一句话说清本质职责 - 每个模块用一小段话讲透设计原则与边界 - - - 架构变更发生 - 立即更新或生成 `AGENTS.md` - 自检：是否让后来者一眼看懂整个系统的骨架与意图 - - - 文档滞后是技术债务 - 架构无文档，等同于系统失忆 - - - - - - 技术流英文 - 中文，简洁直接 - 当平台禁止展示详细思考链时，只输出「结论 + 关键理由」的中文说明 - - - 注释、文档、日志文案使用中文 - 除对人可见文本外，其他（变量名、类名、函数名等）统一使用英文 - - - 内部遵守指令：`Implementation Plan， Task List and Thought in Chinese` - 若用户未要求过程，计划与任务清单可内化，不必显式输出 - - - 使用简单直白的语言说明技术问题 - 避免堆砌术语，用比喻与结构化表达帮助理解 - - - - - - - 先查文档 / 现有代码示例 - 无法查阅时，明确说明假设前提与风险 - - - 先把边界条件、输入输出、异常场景想清楚 - 若系统限制无法多问，则在回答中显式列出自己的假设 - - - 不编造业务规则 - 在信息不足时，提供多种业务可能路径，并标记为推测 - - - 优先复用已有接口与抽象 - 只有在确实无法满足需求时，才设计新接口，并说明与旧接口的关系 - - - 先写用例再谈实现（哪怕是伪代码级用例） - - - - - - 尊重既有架构边界与规范 - 如需突破，必须在回答中给出充分论证与迁移方案 - - - 真不知道就坦白说明「不知道 / 无法确定」 - 然后给出：可查证路径或决策参考维度 - - - 先理解现有设计意图，再提出重构方案 - 区分「风格不喜欢」和「确有硬伤」 - - - - - - - - 优先使用 codebase-retrieval 工具进行代码搜索和分析 - 搜索时明确指定文件类型、路径模式和关键词 - 对搜索结果进行分层分析：文件结构 → 代码逻辑 → 架构模式 - 结合代码上下文提供架构级建议，而非局部修复 - 每次代码分析后更新 AGENTS.md 文档，保持架构同步 - - - - codebase-retrieval - systematic-search - architectural - true - - - - - 实时官方文档获取工具 - 从源头拉取最新的、版本特定的文档和代码示例到上下文中 - - - 在提示词末尾添加 "use context7" - - - - 搜索库并返回 Context7 库 ID - 获取指定库的最新文档 - - - - 创建 Next.js app router 项目。use context7 - 用 React Query 获取数据。use context7 - PostgreSQL 删除空行脚本。use context7 - - - 需要最新 API、框架文档、避免过时代码时 - - - - - - - 梳理问题、约束、成功标准 - - - 若用户允许多轮交互：先给方案大纲，让用户确认方向 - 若用户只要结果：在内部完成自审后直接给出最终方案 - - - 拆分为可逐个实现与验证的小步骤 - - - 若用户时间有限或明确要求「直接给结论」，可仅输出最终结果，并在内部遵守上述流程 - - - - 适用于涉及文件结构 / 代码组织设计的回答（包括伪改动）： - - 执行前说明 - 简要说明： - 做什么？ - 为什么做？ - 预期会改动哪些「文件 / 模块」？ - - - 执行后说明 - 逐行列出被「设计上」改动的文件 / 模块（即使只是建议）： - 每行格式示例：`path/to/file: 说明本次修改或新增的职责` - 若无真实文件系统，仅以「建议改动列表」形式呈现 - - - - - - 简化是最高形式的复杂 - 能消失的分支永远比能写对的分支更优雅 - 代码是思想的凝结，架构是哲学的具现 - - - 恪守 KISS（Keep It Simple, Stupid）原则 - 以第一性原理拆解问题，而非堆叠经验 - 有任何可能的谬误，优先坦诚指出不确定性并给出查证路径 - - - 每一次重构都是对本质的进一步逼近 - 架构即认知，文档即记忆，变更即进化 - ultrathink 的使命：让 AI 从「工具」进化为真正的创造伙伴，与人类共同设计更简单、更优雅的系统 - Let's Think Step by Step - Let's Think Step by Step - Let's Think Step by Step - 代码可解释性先于一切 - 代码可解释性先于一切 - 代码可解释性先于一切 - - - \ No newline at end of file diff --git a/documents/AGENTS.md b/documents/AGENTS.md index 02050f8..ec7c54b 100644 --- a/documents/AGENTS.md +++ b/documents/AGENTS.md @@ -22,10 +22,12 @@ documents/ - 新增/修改文档内容 - 修复错误和过时信息 - 添加新的实战案例 + - 为每个一级目录维护 `README.md` 作为索引入口（如存在） ### 禁止 - 删除现有文档（除非明确要求） - 修改目录编号前缀规则 + - 大规模重命名/移动文件导致链接失效（如必须调整，需同步更新引用） ## 命名规范 diff --git a/prompts/AGENTS.md b/prompts/AGENTS.md index fa99f26..5c8a92e 100644 --- a/prompts/AGENTS.md +++ b/prompts/AGENTS.md @@ -25,6 +25,7 @@ ### 禁止 - 在本地创建提示词文件（应添加到云端表格） - 删除 README.md + - 在本目录写入敏感信息（密钥/Token/个人路径等） ## 相关工具 diff --git a/skills/AGENTS.md b/skills/AGENTS.md index 4c6cb32..fb98206 100644 --- a/skills/AGENTS.md +++ b/skills/AGENTS.md @@ -1,30 +1,47 @@ -# AGENTS.md（skills/05-生产力） +# Skills 目录 Agent 指南 -本目录用于收纳「生产力类」技能：偏向内容生产、格式转换与交付物构建。 +本目录用于收纳可复用的 **Skills（技能模块）**：每个子目录代表一个“可触发、可复用、可交付”的能力包，通常包含入口文档 `SKILL.md`，以及可选的脚本/参考资料/资产文件。 -## 目录结构 +## 目录结构（约定） ```text -skills/05-生产力/ -├── AGENTS.md -└── markdown-to-epub/ - ├── SKILL.md - ├── agents/ - │ └── openai.yaml - └── scripts/ - └── build_epub.py +skills/ +├── AGENTS.md # 本文件（目录级行为准则） +├── README.md # skills 总览与索引 +├── / # 一个技能 = 一个目录 +│ ├── SKILL.md # 入口：触发条件/边界/交付物/流程 +│ ├── references/ # (可选) 参考资料与索引 +│ ├── scripts/ # (可选) 可执行脚本/自动化 +│ ├── assets/ # (可选) 模板/样例/静态资源 +│ └── agents/ # (可选) Agent 元数据（如 openai.yaml） +└── skills-skills/ # 元技能：生成/校验/脚手架化其它技能 ``` ## 模块职责与边界 -- `markdown-to-epub/`：将 Markdown 手稿 + 本地图片资产稳定转换为 EPUB，并做最小可用的完整性校验。 - - `markdown-to-epub/SKILL.md`：面向使用者的入口文档（触发条件、边界、快速上手、排错）。 - - `markdown-to-epub/agents/openai.yaml`：Codex Skill 的交互入口元数据（展示名、默认提示语）。 - - `markdown-to-epub/scripts/build_epub.py`：核心实现脚本（重写图片引用、拷贝资产、调用 `ebook-convert`、输出报告）。 +- 每个 `/` 必须以 `SKILL.md` 作为入口，明确： + - 触发条件（何时用） + - 不适用/边界（何时不用） + - 交付物（要产出什么文件/结论） + - 最小可复现流程（命令/步骤/输入输出） +- 技能目录之间尽量 **无隐式耦合**：不要依赖别的技能目录中的“隐式文件路径/脚本副作用”。 +- 通用逻辑优先下沉到 `libs/common/`，技能目录只保留“该领域必要的最薄封装”。 -## 依赖与上下游 +## 操作规范 -- 上游输入：Markdown 手稿文件、同目录或指定根目录下的本地图片。 -- 外部依赖：Calibre `ebook-convert`（用于实际转换）。 -- 下游输出：EPUB 文件 + `build_dir/` 工作目录（规范化 Markdown、assets、转换日志、报告 JSON）。 +### 允许 +- 新增技能目录（优先复用现有模板与规范） +- 迭代现有 `SKILL.md` 的触发条件、边界与交付物定义 +- 为技能补齐 `references/` 索引或 `scripts/` 自动化 +### 禁止 / 不推荐 +- 在 `skills/` 下按“编号分类目录”拆层级（保持扁平，靠 `README.md` 建索引） +- 让脚本默认写入不可审计的全局路径（优先输出到技能目录内或明确的 `artifacts/`） + +## 快速定位（常用技能） + +- `skills/tmux-autopilot/`：tmux 自动化操控与多 Agent 协作 +- `skills/canvas-dev/`：Canvas 白板驱动开发 +- `skills/sop-generator/`：SOP 生成与规范化 +- `skills/markdown-to-epub/`：Markdown → EPUB 稳定构建 +- `skills/skills-skills/`：元技能（技能生成/校验/脚手架） diff --git a/workflow/AGENTS.md b/workflow/AGENTS.md index c351c39..3970cbc 100644 --- a/workflow/AGENTS.md +++ b/workflow/AGENTS.md @@ -1,30 +1,43 @@ # Workflow 目录 Agent 指南 -## 目录用途 +`workflow/` 存放可复用的工作流模板：把“需求 → 计划 → 实施 → 验证 → 总控复盘”等流程固化为可重复、可审计的自动化路径。 -`workflow/` 存放可复用的工作流模板，用于自动化开发流程。 +## 目录结构（当前） -## 目录结构 - -``` +```text workflow/ -├── auto-dev-loop/ # 自动开发循环工作流 -└── canvas-dev/ # Canvas白板驱动开发工作流 +├── AGENTS.md # 本文件（目录级行为准则） +├── README.md # workflow 总览 +├── auto-dev-loop/ # 全自动开发闭环（五步状态机） +│ ├── README.md +│ ├── CHANGELOG.md +│ ├── step1_需求输入.jsonl +│ ├── step2_执行计划.jsonl +│ ├── step3_实施变更.jsonl +│ ├── step4_验证发布.jsonl +│ ├── step5_总控与循环.jsonl +│ ├── .kiro/ # Kiro 集成配置 +│ ├── workflow_engine/ # 轻量状态机引擎（state + hook） +│ └── workflow-orchestrator/ # 编排技能文档与规范 +└── canvas-dev/ # Canvas 白板驱动开发工作流 + ├── README.md + ├── prompts/ + ├── templates/ + └── examples/ ``` ## 操作规范 ### 允许 -- 新增工作流模板 -- 修改现有工作流配置 -- 添加工作流文档说明 +- 新增工作流模板（新建 `/` 子目录） +- 迭代现有工作流的 `README.md`、提示词/模板/脚本 +- 为工作流补齐最小可运行路径（输入 → 执行 → 产物） -### 禁止 -- 删除现有工作流（除非明确要求） +### 禁止 / 不推荐 +- 破坏现有工作流的“入口约定”（例如把 `README.md` / 关键提示词文件移走） +- 在脚本中写死个人环境路径（优先相对路径或通过参数注入） -## 工作流规范 +## 工作流落地标准（建议） -每个工作流应包含： -- `README.md` - 使用说明 -- 配置文件或脚本 -- 示例/模板文件（可选） +- 必有：`README.md`（一页讲清：目的、输入输出、如何运行、失败怎么排） +- 有状态机/脚本的工作流：必须明确 **唯一状态入口文件**（例如 `state/current_step.json`）与产物落盘目录（例如 `artifacts/`） diff --git a/workflow/auto-dev-loop/workflow-orchestrator/AGENTS.md b/workflow/auto-dev-loop/workflow-orchestrator/AGENTS.md index ca9e3a0..a744942 100644 --- a/workflow/auto-dev-loop/workflow-orchestrator/AGENTS.md +++ b/workflow/auto-dev-loop/workflow-orchestrator/AGENTS.md @@ -3,17 +3,19 @@ ## 目录骨架 ``` workflow-orchestrator/ +├── AGENTS.md # 本文件（目录级约束） ├── SKILL.md # 技能入口，状态机与 hook 约定 +├── CHANGELOG.md # 变更记录 ├── references/ │ └── index.md # 参考索引与待补充子文档 ``` ## 职责与依赖 -- 职责：用文件事件 hook + 轻量状态机编排 `workflow_steps/step1~step5`，支持失败回跳、归档与闭环。 -- 上游：`workflow_steps/step1_需求输入.jsonl` ... `step5_总控与循环.jsonl`（提示词定义）。 -- 下游：`workflow_engine/*`（建议的执行脚本/状态文件目录），`artifacts/` 与 `state/` 产物。 +- 职责：用文件事件 hook + 轻量状态机，编排 `step1~step5` 的自动执行，支持失败回跳、归档与闭环。 +- 上游：`../step1_需求输入.jsonl` ... `../step5_总控与循环.jsonl`（五步提示词定义）。 +- 下游：`../workflow_engine/*`（状态机引擎与 Hook），产物落盘到 `../workflow_engine/artifacts/`。 ## 使用要点 -- 状态文件：`workflow_steps/state/current_step.json` 为唯一调度入口；每次更新即触发对应 Runner。 +- 状态文件：`../workflow_engine/state/current_step.json` 为唯一调度入口；每次更新即触发对应 Runner。 - 总控逻辑：Step5 依据 `verify.status` 回跳 step2 或标记完成；防止无限循环需在 Runner 中实现熔断计数。 -- 产物：建议按 `artifacts//.{json,md}` 落盘，便于审计与归档。 +- 产物：按 `../workflow_engine/artifacts//.{json,md}` 落盘，便于审计与归档。