audit-first-commentary
CommunityDocument code with invariants and tradeoffs.
Software Engineering#documentation#code-quality#code-review#invariants#inline-comments#failure-modes#design-tradeoffs
Authordylanmarriner
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Documenting non-trivial code with explicit invariants, failure modes, and design tradeoffs to improve readability, maintenance, and auditability.
Core Features & Use Cases
- Invariants & Failure Modes: Each file includes a concise summary of invariants and potential failure modes.
- Tradeoff Rationale: Document decisions including alternatives, risks, and mitigations.
- Use Case: Refactor a complex module by capturing design decisions to aid future contributors.
Quick Start
Add a concise file-level documentation block at the top of a non-trivial file describing its purpose, invariants, and failure modes.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: audit-first-commentary Download link: https://github.com/dylanmarriner/windsurf-hooker/archive/main.zip#audit-first-commentary Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.