What problem does it solve?
Codebases often become noisy and hard to maintain when guidelines are unclear about when to comment, what to say, and how to handle output statements. This Skill helps developers write and modify code more clearly by emphasizing the difference between explaining why and what, and by guiding when to emit output.
Core Features & Use Cases
- Universal applicability: Applies to writing or modifying code in any programming language, including adding functions, fixing bugs, or implementing features.
- Comment strategy: Encourages comments that explain why something is done, not what the code does.
- Output guidance: Defines when output statements are appropriate and when to avoid them to keep logs meaningful.
- Language-specific extension: Points to language-specific skills like js-writer for JavaScript or zsh-writer for ZSH to tailor conventions.
Quick Start
Refactor a function to minimize noise and ensure comments explain why, not what.