What problem does it solve?
It prevents maintainability debt by standardizing file headers, comment intent, configuration and environment handling, and extraction rules so future developers can understand and safely change the codebase.
Core Features & Use Cases
- Staff-grade file headers: Add concise JSDoc at the top of services/utilities/complex modules to declare purpose, responsibilities, and dependencies.
- Comment rules that explain WHY: Document non-obvious business logic, workarounds, edge cases, and decision rationale instead of repeating what the code already shows.
- Typed configuration and safe env management: Centralize config under a dedicated folder, validate environment variables at startup with Zod, and enforce .env.example committed with placeholders while keeping real .env values uncommitted.
- Extraction thresholds for React + Tailwind: Extract repeated Tailwind class patterns when they appear 3+ times, and pull magic numbers/strings into constants for clarity.
- Maintainability checklist: Keep modules small (single responsibility, under ~300 lines) and consistent across new and existing files.
Quick Start
Ask to update a new feature file to include a JSDoc header, replace any comments that explain WHAT with WHY-focused rationale, and add typed Zod-based env validation using a .env.example template while extracting repeated Tailwind classes when they occur 3+ times.
