# Cs Audit

> Cs Audit is an Agent Skill for testing & quality published in the codestable/CodeStable repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

系统审计。触发：审查系统、扫描 bug/安全/性能/架构债，产出发现清单。不要用于审查单次改动 diff(cs-code-review)、修已知 bug(cs-issue)、实现功能(cs-feat)、行为等价重构(cs-refactor)、沉淀已知经验(cs-keep)；这是仓库级只读投查，只发现不定修。

- Skill name: `cs-audit`
- Category: [Testing & Quality](https://www.openparable.com/skill/testing-quality/1)
- Source: https://github.com/codestable/CodeStable/blob/HEAD/plugins/codestable/skills/cs-audit/SKILL.md
- Repository: codestable/CodeStable (1,069 GitHub stars when collected)

## SKILL.md

# cs-audit

## 启动必读

动作前先跑 CodeStable preflight：读 `.codestable/attention.md`（缺失先 `cs-onboard`）；不要用 `AGENTS.md`/`CLAUDE.md` 等外部入口代替它；细则见 `.codestable/reference/execution-conventions.md`。

`cs-issue` 等你报 bug，`cs-refactor` 等你指优化点，`cs-keep` 等你说"这事记一下"——但"我也不知道哪有问题，你先扫一遍看看"这个诉求没人接。`cs-audit` 补上这块：**在用户限定的范围内主动扫描，产出一份按严重度 × 性质交叉分类的发现清单**。

本技能只发现、不定修。修是 `cs-issue` / `cs-refactor` 的事。

`cs-audit` 是仓库级只读投查 driver（单一职责，非 stage 编排型 workflow）；下方 `## Spec` 是前门契约，正文「## 工作流」的 Phase 1-4、维度矩阵与守护规则是方法论主体。

## Spec

```haskell
csAudit :: AuditRequest -> AuditOutcome
csAudit req | attentionMissing req = NeedsHuman "route to cs-onboard"
            | otherwise = either Blocked (\s -> selectAuditStep s req) (applyAuditResume req.resumeInput (restoreAuditState req.repoFacts))

data AuditRequest = AuditRequest
  { scopeHint  : Maybe ScopeHint    -- 关键词 / 模块目录 / 一段话；缺则先 Phase 1 收敛
  , dimensions : [Dimension]        -- 用户圈定；空则全扫 5 维
  , selectedFinding : Maybe Path    -- 用户从已完成 audit 中选中的 finding
  , resumeInput : Maybe AuditResume
  , repoFacts  : RepoFacts          -- .codestable/audits/ + adrs/，优先于聊天历史
  , attention  : Maybe Attention    -- .codestable/attention.md；缺则 route to cs-onboard
  }

data ScopeHint = Keyword Text | ModulePath Path | FreeText Text
data Dimension = Bug | Security | Performance | Maintainability | ArchDrift

data AuditState = AuditState        -- 从 .codestable/audits/YYYY-MM-DD-{slug}/ 恢复
  { auditDir       : Maybe Path
  , scope          : Maybe ScopeHint
  , dimensions     : [Dimension]
  , scopeConfirmed : Bool           -- Phase 1 已与用户确认范围（read-only，不改代码）
  , hasIndex       : Bool           -- index.md 是否已写（先 index 后 finding）
  , findingCount   : Int            -- 已产出 finding 数（每维 ≤ 5）
  , adrsPresent    : Bool           -- .codestable/requirements/adrs/ 是否存在（arch-drift 对照源）
  , pendingCheckpoint : Maybe CheckpointReason
  }

data AuditOutcome
  = Scanning AuditState             -- 只读扫描 + 落 index/finding，不产生代码改动
  | RoutedTo SkillName              -- 已选 finding：按建议动作同轮加载 issue/refactor
  | HumanCheckpoint CheckpointReason
  | Completed AuditSummary          -- index 交叉表 + 每条 finding 齐备（含零发现结论）
  | NeedsHuman Reason
  | Blocked Reason

data CheckpointReason
  = ConfirmScope        -- Phase 1 收敛后请用户确认扫描范围与维度
  | WholeRepoRefused    -- 用户要求全仓库盲扫：推回去，先收敛到最常改 / 最近出问题的区域
  | ArchDriftNoAdr      -- 需判架构偏离但 adrs/ 缺失：不得凭记忆，请用户补 ADR 或缩范围
data AuditResume
  = ConfirmAuditScope ScopeHint [Dimension] | NarrowAuditScope ScopeHint [Dimension]
  | ProvideArchitectureAdr Path | ContinueWithoutArchDrift [Dimension]

resumeReason :: AuditResume -> CheckpointReason
resumeReason (ConfirmAuditScope _ _)         = ConfirmScope
resumeReason (NarrowAuditScope _ _)          = WholeRepoRefused
resumeReason (ProvideArchitectureAdr _)      = ArchDriftNoAdr
resumeReason (ContinueWithoutArchDrift _)    = ArchDriftNoAdr

validAuditResume :: AuditResume -> Bool
validAuditResume (ConfirmAuditScope scope dims)      = executableScope scope && validDimensions dims
validAuditResume (NarrowAuditScope scope dims)       = executableScope scope && not (wholeRepoScope scope) && validDimensions dims
validAuditResume (ProvideArchitectureAdr path)       = validAdrPath path
validAuditResume (ContinueWithoutArchDrift dims)     = ArchDrift `notElem` dims && validDimensions dims

applyAuditResume :: Maybe AuditResume -> AuditState -> Either Reason AuditState
applyAuditResume Nothing s = Right s
applyAuditResume (Just resume) s
  | s.pendingCheckpoint == Just (resumeReason resume) && validAuditResume resume = Right (persistAuditResume resume s)
  | otherwise = Left InvalidAuditResume
```

`persistAuditResume` 必须把 scope/dimensions 写回 state 后清除 pending；后续 blind-scan 与 arch-drift guards 只读该 state，不再读取旧 request hint。

`selectAuditStep` 从仓库事实选下一步（决策细则见「## 工作流」各 Phase 与「## 守护规则」；此处只固定分支形态，只读不定修）：

```haskell
selectAuditStep :: AuditState -> AuditRequest -> AuditOutcome
selectAuditStep(s, req)
  | attentionMissing req                               -> NeedsHuman "route to cs-onboard"
  | Just reason <- s.pendingCheckpoint                 -> HumanCheckpoint reason
  | hasSelectedFinding(req)                            -> RoutedTo (recommendedAction req.selectedFinding)
  | wholeRepoBlindScan(s)                              -> HumanCheckpoint WholeRepoRefused
  | not s.scopeConfirmed                                -> HumanCheckpoint ConfirmScope
  | archDriftRequested(s) && not s.adrsPresent          -> HumanCheckpoint ArchDriftNoAdr
  | s.scopeConfirmed && not scanExitCriteriaMet(s)      -> Scanning (nextDimensionScan s)
  | scanExitCriteriaMet(s)                              -> Completed (summary s)  -- 含零发现结论
```

---

## 文件放哪儿

```
.codestable/audits/{YYYY-MM-DD}-{slug}/
├── index.md           # 速览：范围、总评、发现清单交叉矩阵
├── finding-01.md
├── finding-02.md
└── ...
```

日期取审计当天。slug 短到一眼看出审计目标（`auth-module`、`order-flow`、`payment-security`）。

所有 audit 文档带 YAML frontmatter（`doc_type` 分别为 `audit-index` 和 `audit-finding`）便于 `search-yaml.py` 检索。

---

## 维度矩阵（交叉分类）

每个发现打两个标签：

**性质**：`bug` | `security` | `performance` | `maintainability` | `arch-drift`

**严重度**：`P0`（必须修）| `P1`（应该修）| `P2`（可以修）

交叉示例：
- `security` × `P0`：SQL 注入、明文存密码
- `bug` × `P1`：特定边界条件下空指针，实际触发概率低
- `performance` × `P2`：循环内多余的对象分配，热点路径才需要改

另外每个发现带 **置信度**（`high` / `medium` / `low`）和**建议动作**（`cs-issue` / `cs-refactor`）。

完整模板见 `reference.md`。

---

## 工作流

### Phase 1：范围收敛

审计不能全仓库盲扫——成本高、噪音大。先帮用户把范围收窄到可执行。

问用户三样（有一样就能起步）：

1. **关键词**："跟 auth / payment / upload 相关的"
2. **模块 / 目录**："`src/services/` 下面"
3. **一段话描述**："最近用户反馈订单页慢，帮我扫一下订单相关代码"

用户描述已清楚直接进 Phase 2。用户说"整个项目都扫" → 推回去——建议先扫最常改的模块或最近出过问题的区域。

收敛后给用户确认：**"扫 `src/services/order/` 和 `src/api/order.ts`，约 12 个文件，看安全 / 性能 / bug 隐患三个维度。范围 OK 吗？"**

返回任何 `HumanCheckpoint` 前先把 checkpoint、scope 与 dimensions 写入 audit index draft；恢复只接受 reason 对应的 `AuditResume`，无 pending 或不匹配时 `Blocked InvalidAuditResume`。

### Phase 2：扫描

按用户圈定的维度逐维扫描（用户没指定就全扫 5 维）：

- **bug 隐患**：空值路径、边界条件缺失、竞态条件、错误处理吞异常、类型断言无保护
- **安全**：注入风险、敏感数据暴露、权限校验缺失、不安全依赖
- **性能**：N+1 查询、重复计算、无缓存热点路径、内存泄漏、无分页全量加载
- **可维护性**：超长函数（> 80 行）、圈复杂度 > 15、重复逻辑块、神秘常量、循环依赖
- **架构偏离**：代码违反 `.codestable/requirements/adrs/` 已拍板决策、分层泄漏、跨模块隐式耦合

扫描时用 Glob / Grep / Read 真实读代码。每条发现必须记录 `文件:行号` + 具体代码片段。

**上限**：每种维度最多报 5 条。不是凑数——够了就停，不够也不硬凑。

**置信度口径**：
- `high`：代码路径可确认触发，影响明确
- `medium`：静态分析能定位问题，但触发条件不确定
- `low`：线索可疑，需要进一步确认但值得标记

### Phase 3：定级 + 产出

1. 每个发现打性质 + 严重度 + 置信度 + 建议动作
2. 写 `index.md`：范围、总评、发现清单表格（交叉分类）
3. 逐条写 `finding-NN.md`

**先写 index 再写 finding**——这个顺序让 AI 先做整体判断再展开细节，避免陷入单条发现迷失全局。

### Phase 4：建议下一步

index.md 末尾给优先级建议：

- "P0 的 3 条建议立刻开 issue 修"
- "P1 的 5 条可以排下个迭代"
- "P2 的 4 条有空再看"

用户选中 finding 已构成确认。按 finding 的建议动作，在当前 run 加载 `cs-issue` 或 `cs-refactor`，并传递原始 finding 路径、证据与用户选择，不要求重新调用命令。`cs-audit` 自己不修。

---

## 与相邻技能的边界

| 技能 | 触发 | cs-audit 怎么对待 |
|---|---|---|
| `cs-issue` | 用户报已知 bug | audit 发现 bug 后建议开 `cs-issue` |
| `cs-refactor` | 用户指已知优化点 | audit 发现可优化点后建议开 `cs-refactor` |
| `cs-keep` | 沉淀单点经验 / 决策 | audit 是批量扫多维度发现新问题，cs-keep 是把已知的事写下来 |
| `cs-domain` | 维护 ADR / CONTEXT.md | cs-domain 写决策，cs-audit 检查代码是否偏离已拍板的 ADR |
| 宿主专项安全审查 | 深度安全审查 | audit 的安全维度是轻量扫描；深审使用宿主当前可用的专项能力 |

---

## 守护规则

- **不盲扫全仓库**——Phase 1 必须收敛范围，没范围不动手
- **每条发现必有证据**——file:line + 代码片段 + 为什么构成问题。不准出现"感觉不好"、"可能有问题"类无证据发现
- **置信度必标**——不准所有发现都标 `high`
- **每种维度上限 5 条**——逼 AI 挑最值得报的，不是 dump 所有发现
- **只发现不定修**——cs-audit 不出代码改动。出现"顺便修了"就算越界
- **架构偏离引用 ADR**——不准凭记忆判断架构应该长什么样，必须读 `.codestable/requirements/adrs/` 对照
- **旧审计标注过期**——同名模块新审计覆盖旧审计时，旧 index 标 `status: superseded` + `superseded-by: {新目录}`

---

## Failure Behavior

`cs-audit` 停下的两种形态（都只发现不定修，不触碰代码）：

- `NeedsHuman`：无法启动只读投查 driver。`.codestable/attention.md` 缺失（→ `cs-onboard`）；用户既无关键词 / 模块 / 描述，Phase 1 也收敛不出可执行范围；诉求实为审查单次 diff（→ `cs-code-review`）、修已知 bug（→ `cs-issue`）或实现功能（→ `cs-feat`）而非仓库级投查。
- `HumanCheckpoint`：driver 触发上方 `CheckpointReason`。`ConfirmScope`：Phase 1 收敛后请用户确认扫描范围与维度再动手；`WholeRepoRefused`：用户要求全仓库盲扫，推回去先缩到最常改 / 最近出问题的区域；`ArchDriftNoAdr`：要判架构偏离但 `.codestable/requirements/adrs/` 缺失，不得凭记忆，请用户补 ADR 或去掉 arch-drift 维度。

两种情况都要报告：当前 audit 目录（如已建）、`index.md` 与已写 finding 数、阻塞或 checkpoint 原因、需要的用户决策或下一步动作、是否可安全重试或继续。不在范围未确认时盲扫，不在无 ADR 时臆断架构应有形态，不出任何代码改动。

---

## 退出条件

- [ ] 审计范围已和用户确认
- [ ] 各维度扫描完成；有发现则逐条落盘，零发现则在 index 明确记录“未发现明显问题”
- [ ] index.md 含完整交叉分类表
- [ ] 每条发现 file:line + evidence + confidence
- [ ] 每种维度 ≤ 5 条
- [ ] 给用户按优先级排列的下一步建议

---

## 相关文档

- `reference.md` — index.md / finding-NN.md 模板
- `.codestable/reference/shared-conventions.md` — 跨工作流共享口径
- `.codestable/requirements/adrs/` — 架构偏离类发现对照源

---

Source: https://www.openparable.com/skill/testing-quality/cs-audit (OpenParable). Cite the canonical URL above.
