skills.rest
Apostolos-Delis
Apostolos-DelisCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

explain

Explain code files by detailing purpose, functions, data structures, and execution flow.

1|Updated Oct 9, 2018
Search Tags:#code analysis#documentation#code explanation#developer tool#understanding code
One-click install
npx skills add https://github.com/Apostolos-Delis/Dotfiles --skill explain-apostolos-delis
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: explain
Source: https://github.com/Apostolos-Delis/Dotfiles/tree/main/.agents/skills/explain
Command: npx skills add https://github.com/Apostolos-Delis/Dotfiles --skill explain-apostolos-delis

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps users understand complex code or files by providing clear, structured explanations, reducing the time spent deciphering unfamiliar codebases.

Core Features & Use Cases

  • Code Comprehension: Breaks down the purpose, functions, data structures, and execution flow of code.
  • Contextual Explanations: Integrates explanations with specific code references (file:line).
  • Use Case: When encountering a new module in a project, use this Skill to get a quick, high-level overview of its components and how they interact.

Quick Start

Explain the functionality of the file located at '/path/to/your/code.py'.

Frequently Asked Questions about explain

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

FAQPage Schema
How do I understand unfamiliar code in a new module?▼

You can use this Skill to understand unfamiliar code by providing a file path. It analyzes the code and outputs a structured explanation covering its purpose, key functions, data structures, execution flow, and relationships with other system components.

What is the best way to document an existing codebase's execution flow?▼

The best way to document execution flow is using this code analysis tool, which details specific code references like file:line. It contextualizes explanations of data structures and notable patterns, reducing the time spent deciphering complex files.

Can I analyze code relationships and interactions across different system parts?▼

Yes, this Skill analyzes code relationships by integrating explanations of how the given file interacts with other system parts. It provides a high-level overview of component interactions alongside detailed execution flow and data structure breakdowns.

How do I explain what a specific code section does?▼

To explain a specific code section, provide its file path to this Skill. It outputs a structured breakdown of the code's purpose, key functions, data structures, execution flow, and notable patterns, complete with specific code references.

Does this code explanation tool work with any programming language file?▼

Yes, this code explanation tool works with any programming language file you provide. It focuses on detailing functionality, data structures, and execution flow rather than relying on language-specific dependencies or components.

Related Skills

Explore More Software Engineering Skills→
CodeAlive-AICodeAlive-AI
13

codealive-context-engine

Locate relevant code across indexed repositories using natural-language queries.

Official
Advanced
rajyeole6rajyeole6

agency-codebase-onboarding-engineer

Analyze repository structure and execution paths to generate orientation maps.

Community
Advanced
wfukatsuwfukatsu
12

analyze

Analyze system architecture, ubiquitous language, and domain-code mappings into reports.

Community
Advanced
chloebrettchloebrett
3

playground

Create interactive HTML playgrounds with customizable controls and live previews.

Community
Intermediate