design-spec-auditor
Skill38 starsChanged 9 days agoApache-2.0View on GitHub
Verify code implementation aligns with design specifications. Use after implementing features, during code reviews, or when refactoring to ensure architectural compliance. Compares design docs with actual code.
In this repository85 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- docs/llms.txtllms.txt
- llms.txtllms.txt
- agent-inboxSkill
- ailang-core-triageSkill
- ailang-packagesSkill
- benchmark-managerSkill
- benchmark-runnerSkill
- builtin-developerSkill
- cli-doc-maintainerSkill
- cloud-cascade-debugSkill
- cloud-setupSkill
- codebase-organizerSkill
- collaboration-hubSkill
- coordinator-helperSkill
- design-doc-creatorSkill
- design-spec-auditorSkill
- docs-syncSkill
- eval-analyzerSkill
- eval-gap-finderSkill
- gemini-cli-helperSkill
- github-issue-triageSkill
- headless-runnerSkill
- local-model-onboardingSkill
- local-ollama-evalSkill
- mission-briefSkill
- mission-controlSkill
- mission-loop-changeSkill
- model-managerSkill
- motoko-analyzerSkill
- parser-developerSkill
- post-releaseSkill
- pr-monitorSkill
- prompt-managerSkill
- release-managerSkill
- sonarcloud-triageSkill
- sprint-evaluatorSkill
- sprint-executorSkill
- sprint-plannerSkill
- test-coverage-guardianSkill
- trace-debuggerSkill
- use-ailangSkill
- wasm-debuggerSkill
- agent-inboxSkill
- ailang-core-triageSkill
- ailang-packagesSkill
- benchmark-managerSkill
- benchmark-runnerSkill
- builtin-developerSkill
- cli-doc-maintainerSkill
- cloud-cascade-debugSkill
- cloud-setupSkill
- codebase-organizerSkill
- collaboration-hubSkill
- coordinator-helperSkill
- design-doc-creatorSkill
- docs-syncSkill
- eval-analyzerSkill
- eval-gap-finderSkill
- The first 60 shown.
The file
We split this skill into the rules it gives an agent
9 rules. About 0 are common, 9 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈9
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
Verify that code implementations match their design specifications and identify inconsistencies.
- Distinctive: line 40
After implementing new features
- Distinctive: line 77
Do function signatures match spec?
- Distinctive: line 134
Use this checklist for each audit:
- Distinctive: line 153
Action: Update design doc to reflect reality
- Distinctive: line 167
Action: Update design docs
- Distinctive: line 207
When auditing sprint executor or other agent work against design specs, also verify the agent's conversation history to detect skipped …
- Distinctive: line 247
Newer docs supersede older ones: - check dates
- Distinctive: line 248
Some deviations are intentional: - document them
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Design Spec Auditor
Verify that code implementations match their design specifications and identify inconsistencies.
Current State
- Planned design docs: !'ls design_docs/planned/ 2>/dev/null | head -10'
- Implemented design docs: !'ls design_docs/implemented/ 2>/dev/null | tail -5'
- Branch: !'git branch --show-current'
- Recent changes: !'git log --oneline -5'
Use the data above first. Only re-run these commands manually if the injected context is empty or you need to refresh after making changes.
Quick Start
Most common usage:
# User says: "Check if parser matches the design doc"
# This skill will:
# 1. Read design doc (design_docs/planned/ or implemented/)
# 2. Read corresponding code
# 3. Compare and identify discrepancies
# 4. Generate compliance reportWhen to Use This Skill
Invoke when user says:
- "Check if implementation matches design"
- "Audit the parser against its spec"
- "Verify code compliance"
- "Review design alignment"
Also use:
- After implementing new features
- During code reviews
- After refactoring
Workflow
Step 1: Identify Design Documents
# Find relevant design docs
ls design_docs/planned/ # Planned features
ls design_docs/implemented/ # Completed features
# For a specific feature:
find design_docs -name "*parser*" -o -name "*type*"Step 2: Map Design to Code
For each design component, identify:
| Design Element | Code Location |
| Module boundaries | internal/ package structure |
| Interface contracts | Type definitions, function signatures |
| Data flow | Function call chains |
| Error handling | Error types and propagation |
Step 3: Systematic Comparison
Check each design requirement:
- Architectural decisions
- Are module boundaries respected?
- Are dependencies one-way as specified?
- Interface contracts
- Do function signatures match spec?
- Are return types correct?
- Behavioral requirements
- Does error handling match spec?
- Are edge cases covered?
- Performance requirements
- Are complexity bounds met?
- Are resource limits respected?
Step 4: Categorize Discrepancies
| Severity | Definition | Action |
| Critical | Breaks core architectural principles | Fix code immediately |
| Major | Significant behavioral deviation | Fix code or update design |
| Minor | Small inconsistency | Document and track |
| Naming | Terminology mismatch | Update docs for clarity |
| Missing | Specified but not implemented | Add to backlog |
| Extra | Implemented but not specified | Update design doc |
Step 5: Generate Report
Report format:
# Design Compliance Audit: [Feature Name]
## Summary
- **Compliance**: 85%
- **Critical Issues**: 0
- **Major Issues**: 2
- **Minor Issues**: 5
## Critical Issues
(none)
## Major Issues
### Issue 1: Missing error propagation
- **Design doc**: design_docs/implemented/v0_3_0/effects.md, Section 3.2
- **Code location**: internal/effects/handler.go:145-160
- **Discrepancy**: Design specifies errors should propagate to caller; code silently ignores
- **Recommendation**: Fix code to match design
## Minor Issues
...
## Recommendations
1. Update internal/effects/handler.go to propagate errors
2. Add missing test cases for edge conditions
3. Update design doc section 4.1 to reflect actual behaviorComparison Checklist
Use this checklist for each audit:
- Module structure matches design
- Public APIs match signatures in spec
- Error types and handling match spec
- Data structures match definitions
- Invariants are enforced
- Performance requirements met
- Tests cover specified scenarios
- Edge cases handled as specified
Common Discrepancy Patterns
Intentional Deviations
Sometimes code legitimately differs from design:
- Performance optimizations
- Discovered constraints during implementation
- Pragmatic simplifications
Action: Update design doc to reflect reality
Unintentional Oversights
- Forgot to implement a feature
- Misunderstood requirement
- Copy-paste errors
Action: Fix code to match design
Design Drift
Design docs lag behind rapid development:
- Features added without updating docs
- Refactoring changed structure
Action: Update design docs
Example Session
User: "Check if the type system matches its design"
Response:
Auditing type system against design_docs/implemented/v0_3_0/type-system.md...
Reading design doc... Found 15 specified behaviors
Reading code in internal/types/... Found 12 implemented
## Compliance Report: Type System
### Summary
- Compliance: 80%
- Critical: 0
- Major: 1
- Minor: 2
### Major Issues
1. **Row polymorphism extension**
- Design: Section 4.2 specifies record extension syntax `{...r, x: T}`
- Code: internal/types/unify.go only supports field access, not extension
- Action: Implement extension or mark as "planned" in docs
### Minor Issues
1. **Naming**: Design uses "type variable", code uses "tyvar"
2. **Extra**: Code has `TypeCache` not mentioned in design
### Recommendations
1. Implement row extension or update roadmap
2. Add TypeCache to design doc (performance optimization)Auditing Agent-Executed Work
When auditing sprint executor or other agent work against design specs, also verify the agent's conversation history to detect skipped tasks:
# View agent reasoning per turn (grouped text + tool calls)
ailang coordinator logs <task-id> --limit 1000 --json | python3 -c "
import json, sys
data = json.load(sys.stdin)
events = data.get('events', [])
turns = {}; tools = {}
for evt in events:
tn = evt.get('turn_num', 0); st = evt.get('stream_type', '')
if st == 'text': turns.setdefault(tn, []).append(evt.get('text', ''))
elif st == 'tool_use': tools.setdefault(tn, []).append(evt.get('tool_name', '?'))
for tn in sorted(turns.keys()):
text = ''.join(turns[tn]).strip()
if len(text) > 20:
print(f'=== Turn {tn} (tools: {\", \".join(tools.get(tn, []))}) ===')
print(text[:600]); print()
"
# View chain execution flow (recommended)
ailang chains view <chain-id> --spans
ailang chains tree <chain-id> --detailed
# View tool usage timeline (requires server)
ailang dashboard spans --task-id <task-id> --limit 200
# View git changes made by agent
ailang coordinator diff <task-id>Cross-reference checklist:
- Sprint plan acceptance criteria vs actual git diff
- Did agent modify
internal/code or just create examples/docs? - What model was used? (Check
executor.modelin spans - Haiku may be too weak for compiler tasks) - Did it run
ailang run(runtime test) or justailang check(compile test)? - Did it mark tasks as "already working" without verifying the specific bug scenario?
Tips
- Newer docs supersede older ones - check dates
- Some deviations are intentional - document them
- Focus on behavior, not exact wording
- Consider evolution - designs change over time
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

