explain

Included with Lifetime

$97 forever

Search the codebase for function source code and explain it like for a junior developer

General

What this skill does


# Explain Function

You are helping the user understand source code functions in the codebase by finding and explaining them in simple terms.

## Workflow

1. **Get the function name** from the user
   - Ask for clarification if the function name is ambiguous
   - If they mention multiple functions, handle them one at a time

2. **Search the codebase** efficiently
   - Use the Explore agent for fast searching across the codebase
   - Find the function definition and its location
   - Note the file path and line number

3. **Read the source code**
   - Read the complete function implementation
   - Understand its purpose, parameters, and return value
   - Look at how it's used in the codebase for context

4. **Explain like for a junior developer**
   - Start with what the function does in simple terms
   - Break down the logic step-by-step
   - Explain technical terms when introducing them
   - Use analogies or examples when helpful
   - Mention edge cases or important details
   - Explain the "why" behind the implementation choices

5. **Provide context**
   - Show where the function is defined (file:line format)
   - Mention how it's commonly used
   - Link to related functions if relevant

6. **Generate HTML documentation**
   - Create an HTML file with the explanation
   - Use code syntax highlighting for the source code
   - Highlight key parts with background colors and emphasis
   - Mark "tricky parts" with special visual indicators (badges/alerts)
   - Include an interactive table of contents
   - Save the file as `{function_name}_explanation.html` in `~/claude.nosync/questions/`
   - Open the file in the user's default browser

## Key Principles

- Use simple language, avoid jargon when possible
- Explain one concept at a time
- Be thorough but concise
- Focus on understanding, not just describing
- Ask follow-up questions if the user needs more clarification

## HTML Features

The generated HTML includes:
- **Syntax-highlighted code** - Shows the complete function with proper formatting
- **Highlighted key parts** - Important lines marked with colored backgrounds
- **Tricky parts badges** - Special visual markers for complex or error-prone sections
- **Interactive TOC** - Quick navigation between sections
- **Parameter documentation** - Explains each parameter and return value
- **Usage examples** - Shows how the function is typically used
- **Edge cases section** - Warns about potential pitfalls
- **Responsive design** - Works on desktop and mobile
- **Dark/light theme support** - Professional styling with CSS

## Example Response Format

The HTML file generated will include:

1. **Header Section** with function name and location
2. **Quick Summary** - One sentence description
3. **Source Code** - Syntax-highlighted with annotations
4. **How It Works** - Step-by-step breakdown
5. **Parameters & Returns** - Documented input/output
6. **Key Concepts** - Explains important parts with highlights
7. **⚠️ Tricky Parts** - Edge cases and gotchas marked clearly
8. **Common Usage** - Examples of how it's used
9. **Related Functions** - Links to connected code

The file is saved as `~/claude.nosync/questions/{function_name}_explanation.html` and automatically opened in your browser.

Files: 1

Size: 3.3 KB

Complexity: 11/100

Category: General

Source: https://github.com/sejas/ai-code-skills/tree/main/skills/explain

Related in General

modeling-omnistudio-epc-catalog

Included

Salesforce Industries CME EPC product-modeling skill for Product2-based catalog creation. Use when creating EPC products, configuring product attributes, building offer bundles with Product Child Items, or reviewing EPC DataPack JSON metadata for product catalog changes. TRIGGER when: user creates or updates Product2 EPC records, AttributeAssignment payloads, AttributeMetadata/AttributeDefaultValues, Offer bundles, or ProductChildItem relationships. DO NOT TRIGGER when: designing OmniScripts/FlexCards/Integration Procedures (use building-omnistudio-omniscript, building-omnistudio-flexcard, or building-omnistudio-integration-procedure), implementing Apex business logic (use generating-apex), or troubleshooting deployment pipelines (use deploying-metadata).

Generalscripts

relationship-science-coach

Included

Use this skill for direct, practical adult relationship coaching: couples conflict, repair, trust, marriage, dating, flirting, attachment patterns, emotional connection, sex, desire differences, eroticism, kink negotiation, affection, love languages, breakups, and long-term passion. Draw on Gottman, EFT and Hold Me Tight, attachment science, modern sex research, Perel, Nagoski, Kerner, Schnarch, Love and Stosny, and flexible love-language tools. Be concrete and low-hedge. Redirect only for imminent danger, abuse, coercive control, minors, non-consent, self-harm, stalking, or medical/legal/psychiatric decisions.

Generalscripts

building-sf-integrations

Included

Salesforce integration architecture and runtime plumbing with 120-point scoring. Use this skill to set up Named Credentials, External Credentials, External Services, REST/SOAP callout patterns, Platform Events, and Change Data Capture. TRIGGER when: user sets up Named Credentials, External Services, REST/SOAP callouts, Platform Events, CDC, or touches .namedCredential-meta.xml files. DO NOT TRIGGER when: Connected App/OAuth config (use configuring-connected-apps), Apex-only logic (use generating-apex), or data import/export (use handling-sf-data).

Generalscripts

venue-templates

Included

Access comprehensive LaTeX templates, formatting requirements, and submission guidelines for major scientific publication venues (Nature, Science, PLOS, IEEE, ACM), academic conferences (NeurIPS, ICML, CVPR, CHI), research posters, and grant proposals (NSF, NIH, DOE, DARPA). This skill should be used when preparing manuscripts for journal submission, conference papers, research posters, or grant proposals and need venue-specific formatting requirements and templates.

Generalscripts

let-fate-decide

Included

Draws the 12 Houses of the Zodiac Tarot spread to inject entropy into planning when prompts are vague, ambiguous, or casually delegated. Interprets the spread to guide next steps. Use when the user says 'let fate decide', 'YOLO', 'whatever', 'idk', or other nonchalant phrases, makes Yu-Gi-Oh references, or when you are about to arbitrarily pick between multiple reasonable approaches. Prefer over ask-questions-if-underspecified when the user's tone is casual or playful rather than precision-seeking.

Generalscripts

net-ops

Included

Cross-platform network troubleshooting (Windows, macOS, Linux) via local or remote shell. Use for: DNS broken, can't resolve hostnames, nslookup/dig works but apps fail, NRPT, WFP, scutil, /etc/resolver, systemd-resolved, /etc/resolv.conf, NetworkManager, VPN DNS leak residue (ProtonVPN/Mullvad/WireGuard/AnyConnect), AV/firewall blocking DNS or DoH, Tailscale DNS interaction, intermittent connectivity, remote diagnostics over SSH.

Generalscripts