reversa-docs-storyteller

Generate interactive documentation pages from project specs and soul documents.

Updated Mar 31, 2026
One-click install
npx skills add https://github.com/afsjr/secretaria_escola_csm --skill reversa-docs-storyteller-afsjr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: reversa-docs-storyteller
Source: https://github.com/afsjr/secretaria_escola_csm/tree/main/.agents/skills/reversa-docs-storyteller
Command: npx skills add https://github.com/afsjr/secretaria_escola_csm --skill reversa-docs-storyteller-afsjr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Converte especificações técnicas e histórias do sistema em conteúdo de onboarding claro, navegável e visual para quem está chegando ao projeto.

Core Features & Use Cases

  • Glossário interativo com busca cliente-side: transforma a alma do projeto em um glossário com cards e deep-links.
  • Slide deck navegável com onboarding: gera um deck com 6 a 10 slides quando disponível, adaptando o número de slides ao que existe no repositório.
  • Páginas por feature em padrão How a Feature Works: renderiza uma página detalhada para cada feature selecionada a partir dos specs.
  • Encadeamento do fluxo do Time Reversa Docs: prepara assets e indexes necessários para as páginas de documentação.

Quick Start

Run reversa-docs-storyteller to generate the glossario.html, deck.html e as páginas features/ a partir de soul.md e das specs em _reversa_sdd/.

Frequently Asked Questions about reversa-docs-storyteller

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

FAQPage Schema
How do I generate interactive documentation pages from project specs?

Generating interactive documentation pages from specs involves transforming project specs and a soul document into a navigable glossary, a slide deck, and per-feature detail pages using automated spec storytelling converters.

How does client-side search work for glossary documentation?

Client-side search for glossary documentation works by injecting data directly into window.RV_DATA.glossary, enabling instant in-browser search over documentation cards without encountering local fetch CORS failures.

What is the best way to create an onboarding slide deck from markdown requirements?

Creating an onboarding slide deck from markdown requirements is best handled by processing _reversa_sdd requirements.md files to automatically render a navigable HTML deck of 6 to 10 slides adapted to existing content.

Do I need specific configuration files to generate feature pages?

Generating feature pages requires reading .reversa/state.json and .reversa/documentation/.config.json to select features, sourcing content from _reversa_sdd requirements.md files to output detailed documentation.

Are there limitations on where generated documentation files are written?

Generated documentation files are limited to writing exclusively within the .reversa/documentation/ directory, ensuring assets and indexes remain contained for the documentation onboarding workflow.