narrate

Generate a narrative HTML walkthrough from an Allium specification for system stakeholders.

Updated Jul 24, 2026
One-click install
npx skills add https://github.com/oliyh/alluminate --skill narrate-oliyh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: narrate
Source: https://github.com/oliyh/alluminate/tree/main/skills/narrate
Command: npx skills add https://github.com/oliyh/alluminate --skill narrate-oliyh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Allium specifications describe system behaviour precisely but in spec vocabulary that owners, builders, and users of a system struggle to read. This Skill turns a .allium spec into a plain-language narrative document that explains what the system does, why it exists, and how people move through it end to end. ## Core Features & Use Cases - Narrative walkthrough generation: Produces a self-contained static HTML page with a behaviour summary, actor introductions, rationale grounded in the project's own ADRs and decision records, an end-to-end journey, and a closing list of open questions. - Strictly grounded mockups and diagrams: Every mockup field, diagram lifeline, and flow branch is derived only from the spec's declared exposes/provides or the project's real UI and documentation, never invented plausible content. - Consistent visual system: Ships a baseline stylesheet (references/base.css) with typography, mockup frames, sequence/flowchart/timeline diagram scaffolding, actor colour-coding, and click-to-enlarge lightbox, reusable across specs in the same repo. - Use Case: A team with a .allium spec for a workout app needs an onboarding document for a new stakeholder. Run narrate to produce docs/narrate/<spec-name>/index.html telling the system's story with grounded mockups and diagrams. ## Quick Start Use the narrate skill to generate a narrative walkthrough document from the .allium spec in this repository.

Frequently Asked Questions about narrate

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

FAQPage Schema
How do I generate documentation from an Allium spec?

Run the narrate skill against your .allium spec file to produce a narrative HTML walkthrough at docs/narrate/<spec-name>/index.html. It reads the spec, the project's decision records, and any existing UI to build a grounded, plain-language document.

What is the difference between narrate and alluminate?

Narrate produces a prose walkthrough for people who own, build, or use the system, while alluminate produces a structural reference mirroring the spec's own constructs like entity, rule, and surface tables. Use narrate for onboarding and alluminate for the precise rules underneath.

Does narrate require the allium CLI to work?

No, the allium CLI is optional. It provides structured exposes/provides data via model/plan commands, but if unavailable the skill reads the spec directly and applies the same grounding discipline, noting the fallback once in the document.

Can narrate invent UI details not in the spec?

No. Every mockup field, label, and diagram element must trace back to the spec's declared exposes/provides or the project's real UI and documentation. Underspecified screens are rendered sparsely or the gap is named in prose rather than filled with invented content.

Does narrate publish the generated document automatically?

No. Output stays as a local file under docs/narrate/ by default. Publishing to a Claude Artifact or external host only happens if the user explicitly asks, since specs may describe unreleased or internal-only systems.