skills.rest
VoxTechnologies
VoxTechnologiesOFFICIAL
Explore all skills by this author →
WebsiteGitHub

user-guide

Generates a Mintlify user documentation site from PRD files and production screenshots.

4|Updated Mar 14, 2026
Search Tags:#documentation#screenshots#technical writing#playwright#user guide#mdx#mintlify
One-click install
npx skills add https://github.com/VoxTechnologies/transmute-framework --skill user-guide-voxtechnologies
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: user-guide
Source: https://github.com/VoxTechnologies/transmute-framework/tree/main/skills/user-guide
Command: npx skills add https://github.com/VoxTechnologies/transmute-framework --skill user-guide-voxtechnologies

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing end-user documentation from scratch is slow and often drifts out of sync with the actual product. This Skill automates Stage 7D of the Transmute pipeline by turning PRD specifications, user flows, business rules, and the live production application into a complete, deployable Mintlify documentation site. ## Core Features & Use Cases - Journey-Based Content Generation: Derives user journeys from PRD user flows and writes how-to guides, quickstarts, FAQs, troubleshooting, and changelog pages using Mintlify MDX components. - Automated Screenshot Capture: Uses Playwright browser tools to capture up to 30 verified screenshots (and optional MP4 recordings) of public and authenticated pages, with tiered failure handling. - Multi-Agent Coordination: Spawns three parallel teammates (journey writer, concepts/reference writer, config/structure validator) and audits results with a PASS/WARN/FAIL gate decision. - Use Case: After your product passes production smoke testing, ask the agent to generate the user guide — it produces a branded, validated user-guide/ Mintlify site with screenshots, multi-language support, and an audit report. ## Quick Start Ask the agent to generate the user-facing documentation site for the deployed product using the PRD and production URL.

Frequently Asked Questions about user-guide

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

FAQPage Schema
How do I generate user documentation from a PRD automatically?▼

This Skill reads PRD files (user flows, screen specs, user stories) and BRD business rules, then generates a Mintlify documentation site organized by user journey. It rewrites technical specifications into non-technical, task-oriented guides with screenshots.

How to create a Mintlify docs site with screenshots?▼

The Skill captures up to 30 screenshots via Playwright browser tools against the production URL, saves them to user-guide/images/, and embeds them in MDX pages using standard markdown image syntax. Public pages are captured first and must succeed.

What are the prerequisites for running Stage 7D documentation generation?▼

Stage 7V (production smoke verification) must report PASS or CONDITIONAL PASS, and tech-stack.md must not opt out of user documentation. A live production URL is required for screenshots and link verification.

Does Mintlify documentation generation support multiple languages?▼

Yes. If the session language differs from English, the Skill generates English content first, then translates it, using a root docs.json with a navigation.languages array and per-language content directories with identical structure.

Why does Mintlify docs.json validation fail?▼

Common causes include navigation structured as a bare array instead of an object, missing required theme field, deprecated colors.anchors, or footer items using name/url instead of label/href. The Skill runs mint validate before committing to catch these schema errors.

What happens when production screenshots fail during documentation generation?▼

Tiered failure handling applies: public page captures must succeed, authenticated pages fall back from production to dev server, and text-only mode with Note callouts is used only when nothing is accessible. Broken media references cause a FAIL gate decision.

Related Skills

Explore More Content & Communication Skills→
Dragoon0xDragoon0x
4

qa

Generate stack-matched Playwright smoke tests with runner scripts.

Community
Intermediate
willform-aiwillform-ai

wf-domain

Manage custom domain configurations and external access for Kubernetes deployments.

Official
Intermediate
goondocks-cogoondocks-co
12

myco:write-myco-user-documentation

Enforce the Myco doc-voice contract on user-facing documentation before commits.

Official
Intermediate
legioncodeinclegioncodeinc
84

docs-site-stinger

Selects, sets up, and maintains developer documentation sites across seven platforms.

Official
Advanced