make-program-tutorial

Generate reproducible API tutorials with scripts, inputs, and outputs.

7|1|Updated Jul 10, 2025
One-click install
npx skills add https://github.com/igamenovoer/magic-context --skill make-program-tutorial
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: make-program-tutorial
Source: https://github.com/igamenovoer/magic-context/tree/main/skills/writing/make-program-tutorial
Command: npx skills add https://github.com/igamenovoer/magic-context --skill make-program-tutorial

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill enables engineers to generate clear, reproducible, end-to-end tutorials for a specific API/SDK/library, including runnable examples, expected outputs, and basic troubleshooting.

Core Features & Use Cases

  • End-to-end tutorial scaffolding: collects inputs, generates a tutorial document, and creates supporting files (scripts/, inputs/, outputs/).
  • Runnable examples: provides end-to-end scripts that demonstrate the happy path and troubleshooting steps.
  • Reuse and onboarding: suitable for onboarding new developers, documenting internal APIs, and standardizing tutorials across teams.

Quick Start

Provide a topic and audience; the system creates a directory like tut-<what> with tut-<what>.md, scripts/, inputs/, and outputs/. Run the included script to execute the happy path.

Frequently Asked Questions about make-program-tutorial

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

FAQPage Schema
How do I create reproducible API tutorials with runnable scripts?

To create reproducible API tutorials, this skill automates scaffolding end-to-end documents and scripts. It generates a tutorial markdown file alongside scripts, inputs, and outputs directories anchored to your current workspace commit for consistent execution.

What is the best way to document an SDK happy path and troubleshooting steps?

The best way to document an SDK happy path is using automated tutorial scaffolding. This skill generates runnable end-to-end examples and troubleshooting steps, placing executable scripts and expected outputs into structured directories.

How do I generate onboarding materials for new developers using internal APIs?

You can generate onboarding materials for internal APIs by providing a topic and audience. The system creates a standardized tutorial directory containing minimal runnable examples, expected outputs, and basic troubleshooting documentation.

How does the tutorial generation process handle reproducibility across different environments?

Reproducibility is handled by anchoring the generated tutorial scripts and documentation to the current workspace commit. This ensures the runnable examples and expected outputs remain consistent with the specific API or library version being documented.

What file structure is generated when scaffolding an API tutorial?

The generated file structure includes a tut-<what>.md document along with dedicated scripts, inputs, and outputs directories. This layout ensures all executable examples and their corresponding data are organized for immediate end-to-end execution.

Can I use this to standardize tutorials across multiple teams working with different libraries?

Yes, you can standardize tutorials across teams working with different libraries. The skill enforces a structured workflow that produces consistent directory layouts, runnable scripts, and reproducible documentation regardless of the specific API target.