skills/smithery.ai/require-why-when-how-docs

require-why-when-how-docs

Installation
SKILL.md

WHY/WHEN/HOW Documentation Requirements

CRITICAL: EVERY function, class, and complex logic block MUST have comprehensive documentation.

This is NON-NEGOTIABLE. Code without proper documentation will be rejected.

Why This Exists

Undocumented code:

  • Forces readers to reverse-engineer intent
  • Makes onboarding painful
  • Leads to bugs from misunderstanding
  • Becomes unmaintainable over time

Good documentation explains the reasoning (WHY), context (WHEN), and approach (HOW).

When to Apply

Installs
1
First Seen
Mar 26, 2026