Walkthroughs Are Executable Specs

Synchronize documentation with Playwright end-to-end tests and regenerate screenshots.

1|Updated Dec 23, 2025
One-click install
npx skills add https://github.com/jonnymuir/Umbraco.Prism --skill walkthroughs-are-executable-specs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Walkthroughs Are Executable Specs
Source: https://github.com/jonnymuir/Umbraco.Prism/tree/main/.claude/skills/walkthroughs-as-executable-specs
Command: npx skills add https://github.com/jonnymuir/Umbraco.Prism --skill walkthroughs-are-executable-specs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the common issue of documentation drift, where walkthroughs and tutorials become outdated as the underlying software evolves.

Core Features & Use Cases

  • Executable Documentation: Enforces that every walkthrough is backed by an automated Playwright test.
  • Automated Screenshot Capture: Ensures visual documentation is always up-to-date by generating images directly from the test suite.
  • Use Case: When a developer updates a service blueprint, this Skill ensures the corresponding walkthrough markdown and its embedded screenshots are automatically validated or regenerated to reflect the new behavior.

Quick Start

Use the walkthroughs are executable specs skill to validate the current documentation against the latest test suite and regenerate any outdated screenshots.

Frequently Asked Questions about Walkthroughs Are Executable Specs

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

FAQPage Schema
How do I keep documentation screenshots in sync with automated tests?

To prevent documentation drift, executable specs tie human-readable walkthroughs to automated Playwright end-to-end tests, ensuring that any update to application behavior automatically triggers validation or regeneration of the corresponding tutorial markdown and screenshots.

How do I automate screenshot capture for walkthroughs using Playwright?

You automate screenshot capture for walkthroughs by integrating Playwright to run deterministic screenshot capture protocols during your end-to-end test suite, directly generating up-to-date visual documentation images from the test execution results.

Does this approach to executable documentation work with CI/CD pipelines?

Yes, executable documentation integrates with CI/CD pipelines by running Playwright test suites to validate current application state, automatically regenerating outdated screenshots, and enforcing synchronization between markdown walkthroughs and the latest software behavior.

What is documentation drift and how do automated tests prevent it?

Documentation drift occurs when tutorials and walkthroughs become outdated as software evolves, and automated tests prevent it by enforcing synchronization between human-readable markdown and deterministic Playwright test suites that validate visual documentation accuracy.

Do I need Playwright to validate visual walkthroughs against application state?

Yes, you need Playwright integration to validate visual walkthroughs against application state, as it provides the deterministic screenshot capture protocols required to maintain documentation integrity and enforce synchronization with current software behavior.