Skip to content

Repository files navigation

AI 编码代理规则集(Agent-rules)

一套面向 AI 编码代理(Agent)的工程规则集,用于约束 Agent 在编写、修改、审查、重构、删除代码,以及执行 git 提交、连接服务器、启动服务等操作时的行为,避免 Agent 在无人监督时产生难以维护的代码、无法回滚的变更、无人记忆的环境配置

这个仓库是做什么的

核心解决三类问题:

  1. 编码行为不可控:Agent 自由发挥导致过度设计、越界重构、状态悄悄坏掉。规则集定义了从"写代码前"到"交付后"的完整行为约束,并按风险分级(P0红线闭集 → P3工程质量)裁剪执行成本。
  2. 认知无法沉淀:Agent 每次会话都从零推导,改过的东西下次就忘。规则集强制建立 systemmap/(项目认知)、系统级认知文件(本机配置)、服务器架构文档(服务器状态)三层持久化记忆,并配套"渐进式暴露"协议防止记忆文档本身成为新的负担。
  3. 变更不可回滚:代码写完了但文档没同步、提交粒度混乱、敏感信息混进 git 历史。规则集约束提交原子性、提交前敏感信息扫描、文档同步、破坏性操作人工执行。

目录结构

AI编码规范/
├── README.md                          # 本文件:项目介绍
├── Ai编码代理规则集.md                # v2.5(历史版本,保留)
├── AI_编码代理规则集_v2.5.1.md        # v2.5.1(当前正式版,规则0-43 全文)
├── AI编码代理规则集_v2.6(废案).md     # v2.6(废案,不采用)
└── Agent-rules/                       # 技能化版本(可执行入口)
    ├── SKILL.md                       # 技能入口:红线闭集 + 强制前置检查 + 清单机制
    └── references/                    # 按需加载的分层规则细节
        ├── p1-correctness-state.md        # P1 正确性与状态一致性(含规则42)
        ├── p2-observability.md            # P2 可观测性与可追溯
        ├── p3-quality-process.md          # P3 工程质量与效率(含规则43)
        ├── systemmap-protocol.md          # 业务全景 + systemmap + 标题大纲渐进式暴露(规则38/39)
        ├── system-level-cognition.md      # 系统级认知文件 + 服务器架构同步(规则40/41)
        ├── techdebt-protocol.md           # 技术债存储与追踪(规则35)
        ├── git-commit-protocol.md         # Git 提交规范(规则37)
        └── governance-and-checklist-detail.md  # 治理机制完整依据 + 版本历史

版本关系

文件 版本 状态 说明
Ai编码代理规则集.md v2.5 历史 规则0-38,保留作追溯
AI_编码代理规则集_v2.5.1.md v2.5.1 当前正式版 在 v2.5 基础上并入系统级认知、服务器架构同步、启动前状态确认、生产级工程导向,及规则39(渐进式暴露协议),共 43 条规则
AI编码代理规则集_v2.6(废案).md v2.6 废案 曾尝试的改版,不采用
Agent-rules/ v2.5.1 技能化 规则集的"可执行入口",版本与规则集对齐,按优先级分层拆分,供 Agent 按需加载

选择指引

  • 想了解规则全文 → 读 AI_编码代理规则集_v2.5.1.md
  • 想让它真正约束 Agent 的行为 → 用 Agent-rules/ 技能(SKILL.md 是入口,references/ 按需加载)。
  • 想追溯历史条款 → 看 Ai编码代理规则集.mdAgent-rules/references/governance-and-checklist-detail.md 的版本历史。

核心机制速览

  • P0 红线闭集(固定五项):边界数据校验、session token 隔离、幂等、关键假设断言化、安全边界最低要求。任何变更触及这五项,必须完整清单 + 100% 独立核验,不可简化。
  • 交付清单:每次变更附《规则合规性自检清单》,按风险分级(完整清单 / 抽样核验 / 单行简化声明)裁剪。
  • 反作弊核验:清单是 Agent 自填的,触及红线时必须有独立一方抽查核对,防止"自己给自己发合格证"。
  • 三层认知持久化systemmap/(项目)→ 系统级认知文件(本机)→ 服务器架构文档(服务器)。
  • 渐进式暴露:systemmap 文档以 Markdown 标题为导航,Agent 用 Grep ^## 提取标题大纲、手术刀式读取目标区间,代替全文阅读,避免认知文档本身成为 token 负担——不依赖任何生成脚本或动态行号索引。
  • 技术债两级存储:待评估类债归并登记在主题清单文件中,仅确认修复类才一债一文件,避免小文件污染。

使用方式

Agent-rules/ 作为技能注册到 Agent 环境(依据所用 Agent 平台的技能机制),并在项目根目录按需放置 systemmap/techdebt/ 目录。规则集自身强调:不要凭记忆复述规则,以文件为权威来源,按需加载。

About

团队工程规则:写改删审代码、git操作、新/接手项目、技术债前,先按L1-L3分级裁剪,简单任务不拖累,但必须判断级别。

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors