Skip to main content

When to Use

Add this when you need documentation that explains not just what the code does, but why specific implementation decisions were made. Useful for codebases where rationale and decision history must be preserved for future maintainers.

Rule Definition

Name — Document Code Explainability Description — paste this into the rule description field on the platform:

How It Works

  1. Add this rule to your project on the platform
  2. Code is generated with docstrings for all functions, classes, and entry points
  3. Inline comments explain the reasoning behind implementation decisions
  4. Each non-obvious choice includes at least one “Why” category
  5. Code review validates both technical correctness and documentation completeness