app-docs

Solid

Generate complete user documentation for a web app with screenshots. Browses the app via browser automation, screenshots every screen, and produces a structured user guide with step-by-step instructions, annotated screenshots, workflow diagrams, and reference tables. Supports quick (key screens), standard (all pages), thorough (every state and flow), and exhaustive (publishable documentation suite). Triggers: 'document the app', 'user guide', 'app documentation', 'screenshot docs', 'generate user docs', 'help docs', 'how-to guide', 'write the docs'.

Web & Frontend 809 stars 82 forks Updated 2 weeks ago MIT

Install

View on GitHub

Quality Score: 93/100

Stars 20%
97
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# App Documentation Generator Browse a running web app, screenshot every screen, and produce documentation good enough to publish. Not a screenshot dump — a structured guide that teaches someone how to use the app. ## Browser Tool Detection Same as ux-audit — Chrome MCP, Playwright MCP, or playwright-cli. ## URL Resolution Same as ux-audit — prefer deployed/live URL over localhost. ## Depth Levels | Depth | Screenshots | What it produces | Duration | |-------|------------|-----------------|----------| | **quick** | ~10 | Single-page quick-start guide. Key screens, happy path only. | 10-15 min | | **standard** | ~30 | Full user guide. All pages, primary workflows, reference tables. | 30-60 min | | **thorough** | ~80+ | Comprehensive guide. All states, mobile views, every CRUD flow, troubleshooting. | 1-3 hours | | **exhaustive** | ~150+ | Publishable documentation suite. Everything in thorough plus: getting started tutorial, feature-by-feature deep dives, admin guide, keyboard shortcut reference, FAQ, and HTML version. | 3-6 hours | Default: **standard** ## Workflow ### 1. Get App Details Ask the user: - **App URL** (required — or auto-detect from wrangler.jsonc / running dev server) - **App name** (for the guide title) - **Auth** — Chrome MCP uses their session; Playwright needs credentials - **Depth** — quick, standard, thorough, or exhaustive - **Audience** — who reads this? (end users, admins, new team members, clients) ### 2. Discover All Routes Navigate the ...

Details

Author
jezweb
Repository
jezweb/claude-skills
Created
7 months ago
Last Updated
2 weeks ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Solid

product-showcase

Generate a comprehensive marketing website for a web app — multi-page with real screenshots, animated GIF walkthroughs, feature deep-dives, and workflow demonstrations. Browses the running app, captures screens and sequences, and produces a deployable site that actually teaches people what the product does. Especially useful for complex or agentic apps that are hard to explain. Triggers: 'showcase site', 'product page', 'show off the app', 'marketing site', 'demo site', 'product showcase', 'explain the app', 'how do I market this'.

809 Updated 2 weeks ago
jezweb
Web & Frontend Solid

ux-audit

Dogfood web apps — browse as a real user, notice friction, document findings. Adopts a user persona, tracks emotional friction (trust, anxiety, confusion), counts click efficiency, tests resilience (mid-form navigation, back button, refresh), and asks 'would I come back?'. Produces ranked audit reports. Trigger with 'ux audit', 'dogfood this', 'ux walkthrough', 'qa test', 'test the app', or 'check all pages'.

809 Updated 2 weeks ago
jezweb
AI & Automation Listed

write-docs

Generate documentation from a codebase — READMEs, API references, setup guides, runbooks, architecture docs, ship logs, release notes (CHANGELOG + GitHub Release bodies). Not for specifying what to build (use discover), restructuring code (use clean-code), or task decomposition (use breakdown-tasks).

10 Updated 2 days ago
hungv47
Web & Frontend Solid

onboarding-ux

Audit and generate in-app user guidance — onboarding flows, empty states, tooltips, feature tours, contextual help, defaults, and inline hints. Browses the app to find where new users would get stuck, then produces the actual content and code to fix it. Pairs with ux-audit: audit finds problems, this skill builds the solutions. Triggers: 'onboarding', 'help content', 'empty states', 'user guidance', 'first run experience', 'feature tour', 'app is confusing', 'new user experience', 'make the app welcoming'.

809 Updated 2 weeks ago
jezweb
Data & Documents Listed

screenshots

Generate marketing screenshots of your app using Playwright. Use when the user wants to create screenshots for Product Hunt, social media, landing pages, or documentation.

335 Updated today
aiskillstore