tutorial-generator

Tutorial Generator analyzes recent code modifications and refreshes docs/Tutorial.md automatically. It scans changed files to extract key patterns, updates structured sections like Getting Started and Recent Changes, and maintains your existing documentation format while keeping content in sync with the codebase.

The Skill scans modified files to identify what changed, extracts usage details and patterns, then updates docs/Tutorial.md with new sections or appends changes to existing ones. It preserves your current structure, adds an auto-update timestamp, and ensures onboarding docs reflect the latest behavior.

Tutorial Generator requires a docs/Tutorial.md file to function. If your project lacks one, you'll need to create this file first. The Skill then analyzes code changes and populates it with structured sections like Project Structure, Key Components, and How It Works.

The Skill uses file-system tools to read modified files, grep for patterns and functions, and parse changes. It identifies altered classes, functions, and configurations, then extracts relevant usage details to generate documentation entries that reflect the actual code behavior.

Tutorial Generator works with any project containing a docs/Tutorial.md file and source code in modifiable files. It doesn't require specific frameworks or languages—it analyzes text-based code changes and documentation, making it adaptable to diverse project structures and tech stacks.

Use Tutorial Generator when your team frequently merges feature branches, onboarding docs fall out of sync with code, or manual updates are error-prone. It's ideal for active projects where code changes regularly and keeping tutorials current is a maintenance burden.