tutorial-module-writer_skill

This skill writes cohesive TUTORIAL.md modules from approved plans, preserving running example continuity, exercises with verification, and answer outlines.
  • Python

109

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill willoscar/research-units-pipeline-skills --skill tutorial-module-writer

  • SKILL.md3.7 KB

Overview

This skill writes the tutorial module file (output/TUTORIAL.md) from an approved module plan. It produces a sequence of compact, hands-on modules that reuse a single running example and include verifiable exercises and answer outlines.

How this skill works

The skill first confirms that the plan scope and running example were approved in the decisions record. It expands each module from the approved plan into a short module: objective, key concept, worked step on the running example, exercise with expected output and verification, and an answer outline. It enforces guardrails: only the approved scope, consistent running example, and at least one verifiable exercise per module.

When to use it

  • When the module plan is complete and the decisions record contains approval for scope and running example (Approve C2).
  • During the tutorial-writing stage of the pipeline (writing phase C3).
  • When you need a single, consistent running example extended across modules.
  • When exercises must be verifiable with expected outputs and verification steps.

Best practices

  • Confirm approval before writing; stop and request sign-off if approval is missing.
  • Keep each module tightly scoped: objective → concept → worked step → exercise → answer outline.
  • Reuse and evolve the same running example in every module; avoid introducing new examples.
  • Provide concrete verification steps and expected outputs for all exercises.
  • Keep answer outlines helpful but avoid full solution dumps; list common mistakes and checks.

Example use cases

  • Generate a TUTORIAL.md for a multi-module research pipeline after C2 approval to feed into the next pipeline stage.
  • Convert an approved module plan into short teaching modules that a learner can follow and verify.
  • Produce exercises with expected outputs for automated or manual verification during code review.
  • Create instructor-facing material that documents what the learner must build at each step.
  • Rapidly iterate tutorial content while maintaining scope discipline and a single running example.

FAQ

Stop and request sign-off. The skill will not proceed without explicit approval of scope and the running example.

Are full solutions provided for exercises?

No. The skill provides answer outlines and verification steps to help self-check while avoiding full solution dumps.

Built by
VeilStrat
AI signals for GTM teams
© 2026 VeilStrat. All rights reserved.All systems operational
tutorial-module-writer skill by willoscar/research-units-pipeline-skills | VeilStrat