Inline Documentation

What problem does it solve?

This Skill addresses the challenge of maintaining code clarity, safety, and traceability by establishing best practices for concise and informative inline documentation.

Core Features & Use Cases

• Intent and Rationale: Ensures comments explain why code exists, not just what it does.
• Traceability: Integrates requirement, risk, and test IDs directly into code comments for auditability.
• Boundary Documentation: Clarifies assumptions and constraints at code interfaces.
• Use Case: When developing safety-critical firmware, use this Skill to ensure all critical functions and variables are clearly commented with their purpose, any associated risks, and links to their originating requirements.

Quick Start

Apply the inline documentation skill to add traceability tags and clarify the purpose of the critical shutdown function.