Back to Blog

research

Generate Code Reading Tutorials from Your Codebase

Generate annotated code reading tutorials from your own codebase with vocabulary tracking and state inspection.

OpenAgentSkillPublished:

Where this fits

When you join a new codebase or need to explain a complex module to a teammate, the bottleneck is rarely code — it's the tutorial you wish already existed. tutorial-creator lets your agent generate annotated reading tutorials directly from your repository, so you can turn a sprawling codebase into a structured lesson without manually writing every walkthrough.

Why agents benefit

  • Six writing-to-learn entry points — the agent can pick the right starting point based on what you have (topic, file, folder, commit, or plain question) and produce a coherent reading flow.
  • Vocabulary state machine — terms get tracked with status (e.g., "new", "used", "mastered"), so the agent can reuse definitions consistently and flag gaps in your documentation.
  • Independent vocab management — you can manage vocabulary without touching the tutorial generator, letting the agent update terminology as the codebase changes.
  • Learning-state inspection — the status surface gives a read-only dashboard, so the agent can see what's been covered and what's still unknown before suggesting next steps.
  • Gateway-mediated control — three surfaces (tutorial, vocab, status) are clearly separated, so the agent knows exactly which command to call and what to expect.

Practical scenarios

Onboard a new developer to a legacy module

You have a 5,000-line utility class that nobody wants to explain. The agent runs /skill tutorial-creator tutorial --source src/utils/parser.ts --audience junior, and minutes later you have a step-by-step annotated reading with vocabulary definitions for terms like "tokenizer" and "state machine."

Generate a weekly learning update for your team

Before a sprint review, the agent checks status to see which vocabulary terms have been introduced but not yet exercised. It then generates a short "vocabulary refresh" tutorial that targets those gaps, keeping the team's mental model aligned with the actual code.

Turn a git commit into a teachable moment

After merging a complex feature, you run the legacy invocation with the commit hash. The agent traces the changed lines, maps them to existing vocabulary, and produces a diff-by-diff tutorial that explains both the what and the why — useful for code review follow-ups.

Add it to your agent workflow

Install it with:

npx skills add Terryc21/tutorial-creator --skill tutorial-creator

Then invoke it from your agent:

/skill tutorial-creator tutorial --topic "Dependency Injection" --source src/di/container.ts --audience advanced

The agent will generate a structured lesson with code annotations and a vocabulary list, and you can check /skill tutorial-creator status afterwards to see what's been covered.

Compare before adopting

Before committing, look at the project's maintenance freshness (last commit, version 2.0.1), star count (currently 26), and how actively the author Terry Nyberg addresses issues. Compare it to alternatives like writing tutorials manually or using generic documentation generators. The gateway-based surface design means it fits agents that need explicit command routing — if you prefer a more open-ended skill, that may not be your workflow.

Why it is worth tracking

The skill's real signal is the vocabulary state machine and the multiple entry points — that's not a typical "generate docs" trick. With 26 stars and an active author, it's still early-stage, but the v2.1 redesign (three surfaces) suggests a clear product direction. Give it a test on a small module: if the generated tutorials are coherent, it'll save you hours on your next onboarding or documentation sprint. You can see more context on OpenAgentSkill when evaluating it.

Featured Skill

tutorial-creator

Skill by Terry Nyberg, Coffee & Code LLC