跳至正文
OpenAgentSkill
浏览已开放 · 目录记录日期 2026-11-21 · 自动更新和账户服务暂时关闭。
浏览器与自动化

app-docs

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'.

jezweb · 已有静态检查记录

安装与使用

运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。

npx skills add jezweb/claude-skills --skill app-docs

技能说明


name: app-docs description: "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'." compatibility: claude-code-only

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

DepthScreenshotsWhat it producesDuration
quick~10Single-page quick-start guide. Key screens, happy path only.10-15 min
standard~30Full 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 app and build a complete page inventory:

  • Read the sidebar/navigation menu
  • Click through all top-level items and sub-items
  • Note sub-pages, tabs within pages, and nested navigation
  • Check for settings, profile, admin areas, help pages
  • Record the URL and purpose of each page
  • Note which pages have interactive elements (forms, buttons, filters)

Create a task list to track documentation progress.

3. Document Each Page

For each page in the inventory:

a. Navigate and Prepare

  • Navigate to the page
  • Wait for data to load (no skeleton/spinner in screenshot)
  • Resize browser to 1280x720 for consistent screenshots
  • Make sure the page has realistic data — not "Test Client" or empty tables

b. Screenshot the Default State

  • Take a clean screenshot showing the page populated with data
  • Save to docs/screenshots/ with descriptive names

c. Write the Page Section

For each page, write:

## [Page Name]

[One sentence: what this page is for and when you'd use it]

![Page name](screenshots/NN-page-name.png)

### What You'll See
[Describe the key elements: sidebar shows X, main area shows Y, toolbar has Z]

### What You Can Do
[List the actions available, each as a brief description]

### How To: [Primary Action]
1. [Step with screenshot reference]
2. [Step]
3. [Step — screenshot the result]

> **Tip:** [Helpful shortcut or non-obvious feature]

d. Document Key Workflows

For interactive pages, document step-by-step with screenshots at each significant step:

### How To: Add a New Client

1. Click the **"Add Client"** button in the top right
   ![Add button location](screenshots/12-clients-add-button.png)

2. Fill in the required fields — Name and Email are required, everything else is optional
   ![New client form](screenshots/13-clients-new-form.png)

3. Click **"Save"** — you'll be taken to the new client's detail page
   ![Client saved confirmation](screenshots/14-clients-saved.png)

> **Tip:** You can also press **Cmd+N** from anywhere to create a new client.

e. Depth-Specific Extras

Extraquickstandardthoroughexhaustive
Empty statesSkipNoteScreenshot + documentScreenshot + suggest improvements
Error statesSkipNoteTrigger + screenshotEvery validation error documented
Dark modeSkipSkipScreenshot key pagesScreenshot every page
Mobile (375px)SkipSkipScreenshot key pagesScreenshot every page
All CRUDSkipPrimary onlyEvery operationEvery operation + edge cases
Settings/configSkipList optionsDocument eachDocument each with examples
Keyboard shortcutsSkipList if visibleFull reference tableDedicated section
Search/filtersSkipMentionDocument each filterDocument every combination
Permissions/rolesSkipSkipNote differencesSeparate section per role
API/integrationsSkipSkipMention if presentDocument endpoints + examples

4. Write Supporting Sections

Beyond per-page documentation:

Getting Started (all depths):

## Getting Started

### Accessing [App Name]
- URL: [production URL]
- Supported browsers: Chrome, Firefox, Safari, Edge
- Mobile: [responsive / PWA / not supported]

### Logging In
[Screenshot of login page + steps]

### Your First 5 Minutes
1. [First thing to do after logging in]
2. [Second thing — the quick win]
3. [Third thing — explore the main feature]

Navigation Guide (standard+):

## Navigation

### Sidebar
[Screenshot with annotations describing each section]

### Quick Actions
- **Cmd+K**: Quick switcher — jump to any page or record
- **Cmd+N**: Create new [item]
[Other shortcuts]

### Breadcrumbs / Back Navigation
[How to navigate back, where breadcrumbs appear]

**Key

阅读完整来源 ↗