explain

Name: explain
Availability: InStock
Author: ka2kama

Generate dual-perspective documentation with Mermaid diagrams and tables for code changes.

2|Updated Jan 14, 2026

Search Tags:#documentation #technical writing #code explanation #mermaid diagrams #PR analysis #feature explanation

Ready to run

npx skills add https://github.com/ka2kama/ringiflow --skill explain-ka2kama

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: explain
Source: https://github.com/ka2kama/ringiflow/tree/main/.claude/skills/explain
Command: npx skills add https://github.com/ka2kama/ringiflow --skill explain-ka2kama

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill generates comprehensive documentation for code changes or features, making complex technical details easily understandable for both technical and non-technical audiences.

Core Features & Use Cases

Dual-Perspective Documentation: Creates both functional (What/Why) and code-level (How/Where) explanations.
Visual Aids: Incorporates diagrams (Mermaid) and tables to enhance comprehension.
Use Case: After a complex feature is merged via a Pull Request, use this Skill with the PR number to automatically generate a detailed explanation document that can be shared with the team or added to the project's knowledge base.

Quick Start

Use the explain skill to generate documentation for PR number 456.

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 from a pull request?▼

Generating technical documentation from a pull request involves analyzing the PR number to produce dual-perspective explanations of the code changes. This process outputs functional and code-level details into a structured directory.

What is the best way to explain complex code changes to non-technical team members?▼

Explaining complex code changes to non-technical members is best achieved through dual-perspective documentation. This approach separates functional 'What/Why' explanations from code-level 'How/Where' details for enhanced comprehension.

Can I use mermaid diagrams to visualize software features in my documentation?▼

Yes, you can use mermaid diagrams to visualize software features in your documentation. Generating docs from code or PRs can automatically incorporate visual aids like diagrams and tables to enhance comprehension.

Does this code documentation approach support analyzing existing branches instead of just PRs?▼

Yes, this code documentation approach supports analyzing existing branches. It handles both diff-based analysis of changes using PR numbers and feature-based analysis of existing code using branch names.

How do I document a specific feature area in an existing codebase?▼

To document a specific feature area in an existing codebase, you perform a feature-based analysis using the branch name or feature area. This generates structured documentation detailing the functional aspects and code logic.