explain

Explain files, features, or data flows in structured step-by-step sections.

Updated Jul 24, 2024
One-click install
npx skills add https://github.com/jasonwilmot/little-riddle --skill explain-jasonwilmot
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: explain
Source: https://github.com/jasonwilmot/little-riddle/tree/main/.claude/skills/explain
Command: npx skills add https://github.com/jasonwilmot/little-riddle --skill explain-jasonwilmot

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides clear, structured explanations of specific files, features, or data flows to speed understanding, onboarding, and decision-making.

Core Features & Use Cases

  • Structured, step-by-step deep-dives covering overview, components, data flow, edge cases, and related code.
  • Useful for onboarding, code reviews, architecture discussions, and technical documentation.
  • Use Case: when you need a thorough, shareable explanation of how a module works across its inputs, processes, and outputs.

Quick Start

Ask me to explain a specific file, feature, or data flow, and I will provide a structured, actionable walkthrough.

Frequently Asked Questions about explain

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate technical documentation for a complex software module?

You can get a structured deep-dive explanation of a specific file or feature by requesting an overview of its key components, data flow, and edge cases. This provides a step-by-step, shareable walkthrough of how the module works across its inputs, processes, and outputs.

What is the best way to explain data flow and dependencies for developer onboarding?

The best way to explain data flow for developer onboarding is to generate a structured technical breakdown covering the overview, dependencies, and related code. This produces clear, actionable documentation that speeds up understanding and decision-making for new team members.

How do I document edge cases and architecture decisions for a code review?

To document edge cases and architecture decisions for a code review, request a structured explanation of the specific feature. It targets software projects by maintaining dedicated sections for edge cases, dependencies, and data flow to provide clear, actionable walkthroughs for reviewers.

Can I get a structured walkthrough of a data pipeline covering inputs and outputs?

Yes, you can get a structured walkthrough of a data pipeline by requesting an explanation of the specific data flow. It targets software projects and pipelines, providing a thorough breakdown of how the system works across its inputs, processes, and outputs.

Does this approach work for documenting specific files without generating full project wikis?

Yes, this approach works for documenting specific files without generating full project wikis because it provides targeted, deep-dive explanations of individual files or features. It maintains structured sections like quick reference and related code rather than broad, generalized overviews.