cc-os/plugins/cc-architect/templates/audit-checklist-template.md

149 lines
4.1 KiB
Markdown
Raw Normal View History

# CC-Architect Audit Checklist
**Model**: Haiku (mechanical verification, no judgment)
## Instructions
Run this checklist against any cc-architect output (plugin, skill, workflow). Check each item and mark pass/fail. If any CRITICAL items fail, escalate to Sonnet for severity analysis.
---
## Universal Attributes (All Outputs)
### Structure
| # | Check | Command/Method | Pass | Fail |
|---|-------|----------------|------|------|
| 1 | Directory exists | `ls -d {target_path}` | ☐ | ☐ |
| 2 | Required files present | See per-type checklist below | ☐ | ☐ |
| 3 | No empty files | `find {path} -empty -type f` returns nothing | ☐ | ☐ |
| 4 | Naming convention | All files/dirs are `kebab-case` | ☐ | ☐ |
### Frontmatter
| # | Check | Validation | Pass | Fail |
|---|-------|------------|------|------|
| 5 | Description present | `description:` field in frontmatter | ☐ | ☐ |
| 6 | Description passes escape hatch | Would user skip reading full file? | ☐ | ☐ |
| 7 | No placeholder text | No `TODO`, `FIXME`, `[PLACEHOLDER]` | ☐ | ☐ |
### Cross-References
| # | Check | Validation | Pass | Fail |
|---|-------|------------|------|------|
| 8 | All paths resolve | Every `references/` path exists | ☐ | ☐ |
| 9 | No broken links | Every `[text](path)` link resolves | ☐ | ☐ |
### Model Annotations
| # | Check | Validation | Pass | Fail |
|---|-------|------------|------|------|
| 10 | Tasks have model tier | Each task annotated with Haiku/Sonnet/Opus | ☐ | ☐ |
| 11 | Pre-planning present | Orchestrator-invoked skills have pre-planning step | ☐ | ☐ |
---
## Plugin-Specific Attributes
### Required Files
- [ ] `CLAUDE.md` exists
- [ ] `.claude-plugin/plugin.json` exists and valid JSON
- [ ] At least one skill in `skills/` OR workflow in `workflows/`
### Plugin Manifest (plugin.json)
- [ ] `name` field present
- [ ] `description` field present
- [ ] `skills` array lists all skills in `skills/` directory
---
## Skill-Specific Attributes
### Required Files
- [ ] `SKILL.md` exists
- [ ] `invariants.md` exists (may be empty if no invariants yet)
- [ ] `examples/golden/` directory exists
### SKILL.md Content
- [ ] Has frontmatter with `description`
- [ ] Has "When to use" section
- [ ] Has phase structure (Setup → Process → Synthesize or equivalent)
- [ ] References to shared docs use relative paths
### Invariants
- [ ] At least 1 invariant defined OR explicit "no invariants yet" note
- [ ] Invariants are testable (not vague)
---
## Workflow-Specific Attributes
### Required Frontmatter Fields
```yaml
---
name: required
description: required
triggers: required (array)
model_tier: required (haiku|sonnet|opus)
complexity: optional (1-5)
requires_user_input: optional (true|false)
depends_on: optional (array of workflow names)
---
```
### Workflow Content
- [ ] "When to use" section present
- [ ] "Inputs required" section present
- [ ] "Phases" or "Steps" section present
- [ ] Each phase has model tier annotation
---
## Domain Plugin Attributes (Specialized Fields)
Only applies to domain-specialist plugins (e.g. plugins that encode a professional discipline's frameworks and heuristics, not general-purpose tooling).
- [ ] Domain expertise documented in references/
- [ ] Professional frameworks captured
- [ ] Heuristics are specific, not generic
- [ ] Workflow categories identified (if applicable)
---
## Escalation Criteria
**Escalate to Sonnet if**:
- More than 2 FAIL items in Universal Attributes
- Any CRITICAL item fails (marked below)
- Subjective judgment needed (e.g., "is description good enough?")
**CRITICAL Items** (must pass):
- #2 (Required files present)
- #5 (Description present)
- #10 (Tasks have model tier)
---
## Output Format
```markdown
## Audit Report: {target_name}
**Date**: {date}
**Auditor**: Haiku
**Target**: {path}
### Summary
- Universal: {X}/11 passed
- Type-specific: {Y}/{Z} passed
- **Status**: PASS | FAIL | ESCALATE
### Failed Items
1. #{number}: {description}
- Expected: {what should exist}
- Actual: {what was found}
### Recommendations
- {If ESCALATE, note what Sonnet should review}
```