teach

Name: teach
Availability: InStock
Author: barrettlowe

Generate HTML teaching artifacts with sequence diagrams and quizzes from code.

Updated Mar 7, 2016

Search Tags:#code analysis #interactive learning #sequence diagram #code education #teaching artifact

Ready to run

npx skills add https://github.com/BarrettLowe/dotfiles --skill teach-barrettlowe

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: teach
Source: https://github.com/BarrettLowe/dotfiles/tree/main/claude/skills/teach
Command: npx skills add https://github.com/BarrettLowe/dotfiles --skill teach-barrettlowe

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python, mermaid, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill generates teaching artifacts that help users understand and learn complex code architectures by providing a structured, interactive learning experience.

Core Features & Use Cases

Teaching Artifacts: Creates HTML-based teaching artifacts that include sequence diagrams, architecture decisions, comparison tables, and code snippets.
Code Analysis: Analyzes code to identify execution flow, state, decisions, patterns, and failure modes.
Interactive Learning: Provides interactive scenarios and quizzes to reinforce learning.

Quick Start

Generate a teaching artifact for the 'src/cache.cpp' file using the teach skill.

Frequently Asked Questions about teach

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

FAQPage Schema

How do I generate a sequence diagram from source code for teaching?▼

To generate a sequence diagram from source code, this Skill parses your files using Python and renders the execution flow using Mermaid. It creates interactive HTML teaching artifacts that visually map out code architecture and decisions.

Can I automatically create interactive quizzes and comparison tables from my codebase?▼

Yes, you can automatically create interactive quizzes and comparison tables from your codebase. This Skill analyzes your code to identify patterns and failure modes, embedding these insights into interactive HTML learning scenarios.

What is the best way to document code architecture decisions for new engineers?▼

The best way to document code architecture decisions is by generating structured teaching artifacts. This Skill analyzes your code to extract state and patterns, producing HTML documents with diagrams and comparison tables for new engineers.

Do I need Python and Mermaid installed to generate code analysis teaching artifacts?▼

Yes, you need Python and Mermaid installed to generate code analysis teaching artifacts. Python is required for parsing the code and analyzing execution flow, while Mermaid handles the sequence diagram generation.

Does this code education tool work for analyzing failure modes and execution flow?▼

Yes, this code education tool works for analyzing failure modes and execution flow. It processes your source files to identify state changes, decisions, and potential failures, embedding these insights into interactive learning modules.

How to create an interactive learning module for complex code architectures?▼

To create an interactive learning module for complex code architectures, provide your source file to this Skill. It will analyze the execution flow and generate an HTML artifact featuring sequence diagrams, architecture decisions, and quizzes.