ai-coding-ok AGENTS.md

AGENTS.md — ai-coding-ok

⚠️ AI Agent 必读规范（每次任务必须执行）

本项目使用 ai-coding-ok 三层记忆系统。在执行任何任务之前，必须完成以下步骤：

Plan 阶段（强制，任务开始前）

1. 读取 AGENTS.md — 本文件，架构速查
2. 读取 .github/agent/system-prompt.md — Agent 人格、角色切换、行为边界
3. 读取 .github/agent/workflows.md — 场景工作流（Feature/Bug/Refactor/发布）
4. 读取 .github/agent/coding-standards.md — 编码规范
5. 读取 .github/agent/memory/project-memory.md — 项目事实和架构约束
6. 读取 .github/agent/memory/decisions-log.md — 历史技术决策
7. 读取 .github/agent/memory/task-history.md — 近期任务上下文

Act 阶段（强制，任务结束后）

1. 更新 .github/agent/memory/task-history.md — 记录本次任务摘要
2. 如有架构决策变化 → 更新 .github/agent/memory/decisions-log.md
3. 如有项目事实变化 → 更新 .github/agent/memory/project-memory.md
4. 如 AGENTS.md / system-prompt.md / workflows.md / coding-standards.md 有事实性过时内容 → 同步更新对应文件

⛔ 以上步骤不可跳过。若在使用 superpowers brainstorming / writing-plans， 在调用这些 skill 之前先完成 Plan 阶段，结束后完成 Act 阶段。

---

项目概述

ai-coding-ok 是一个 AI 编程护栏 Skill 框架。为任意项目安装三层记忆系统（project-memory + decisions-log + task-history）并强制执行 PDCA 工作流，确保 AI Agent 在每次编码任务前后读取和更新项目记忆，解决"AI 修了 bug X 却搞坏了功能 Y"的问题。目标用户是所有使用 Claude Code、GitHub Copilot、Cursor 的开发者。

系统架构与数据流

开发者发起编码任务
      │
      ▼
CLAUDE.md (@AGENTS.md) ──→ AGENTS.md (PDCA 强制指令)
      │
      ├── Plan: 读取 7 个文件（AGENTS + 3 agent 规范 + 3 记忆文件）
      ├── Do:   编码 + 测试
      ├── Check: 验证
      └── Act:   更新记忆文件（task-history 始终 + decisions-log/project-memory 按需）

跨平台兼容层：
  Claude Code  → SKILL.md (Mode A/B/C/D) + CLAUDE.md shim
  Copilot      → .github/copilot-instructions.md (自动加载)
  Cursor       → .cursor/rules/ai-coding-ok.mdc
  Codex        → AGENTS.md (自动加载) + .codex/skills/ai-coding-ok/ (skill)

• SKILL.md — Skill 定义文件，包含 Mode A(Install) / B(Plan) / C(Act) / D(Upgrade) 完整逻辑
• templates/zh/ — 中文安装模板（AGENTS.md + 三层记忆文件 + agent 规范），安装时自动替换占位符。v4.1.0 起为唯一模板源
• scripts/ — install.sh / install.py 自动化安装脚本 + verify.sh 安装验证 + customize-prompt.md / upgrade-prompt.md 手动触发提示