code-explanation
Scannednpx machina-cli add skill NickCrew/claude-cortex/code-explanation --openclawFiles (1)
SKILL.md
1.3 KB
Code Explanation
Overview
Provide clear explanations of code and concepts with appropriate depth, structure, and examples. Adapt the output to the audience level.
When to Use
- Explaining code, architecture, or system behavior
- Producing educational explanations for knowledge transfer
- Clarifying framework or domain concepts
Avoid when:
- The request is strictly documentation generation (use documentation-production)
Quick Reference
| Task | Load reference |
|---|---|
| Explanation workflow | skills/code-explanation/references/explain.md |
| Pedagogical Methodology | skills/code-explanation/references/pedagogical-methodology.md |
Workflow
- Identify target, audience level, and format.
- Load the explanation reference.
- Analyze the code or concept.
- Structure the explanation with progressive depth.
- Validate accuracy and clarity.
Output
- Structured explanation with examples
- Notes on assumptions and follow-ups
Common Mistakes
- Skipping audience level calibration
- Explaining without verifying source behavior
Source
git clone https://github.com/NickCrew/claude-cortex/blob/main/skills/code-explanation/SKILL.mdView on GitHub Overview
Code explanations are provided with appropriate depth, structure, and examples, adapted to the audience level. It helps explain code, architecture, or system behavior and supports knowledge transfer.
How This Skill Works
Identify the target audience level and output format, then load the explanation reference. Next, analyze the code or concept and structure the explanation with progressive depth, finally validating accuracy and clarity against the source behavior.
When to Use It
- Explaining code, architecture, or system behavior
- Producing educational explanations for knowledge transfer
- Clarifying framework or domain concepts
- Tailoring explanations to a specific audience level or format
- Validating explanations for accuracy and clarity
Quick Start
- Step 1: Identify target audience level and preferred format
- Step 2: Load the explanation reference and analyze the code or concept
- Step 3: Structure the explanation with progressive depth and validate against source behavior
Best Practices
- Calibrate explanation depth to the audience level before starting
- Load the explanation reference and verify the methodology
- Analyze the code or concept thoroughly and note assumptions
- Structure the explanation with progressive depth and concrete examples
- Validate accuracy against source behavior and document uncertainties
Example Use Cases
- Explain a Python function to junior developers
- Walk through a microservices architecture for an on-call rotation
- Clarify a framework concept (e.g., React hooks) to new engineers
- Explain algorithm choices in a data pipeline
- Provide onboarding-friendly explanations for new team members
Frequently Asked Questions
Add this skill to your agents