write-docs

Included with Lifetime

$97 forever

Generate documentation for custom elements based on their manifest data. Use when the user asks to "write docs", "generate documentation", "document this element", "create API docs", or mentions "usage examples" or "component documentation".

Design

What this skill does


# Write Element Documentation

Generate documentation for custom elements based on their manifest API surface,
including usage examples and integration guidance.

## Workflow

### Phase 1: Gather Element Data

Read the target element's full manifest data:

```text
cem://element/{tagName}
```

And each sub-resource for complete coverage:

```text
cem://element/{tagName}/attributes
cem://element/{tagName}/slots
cem://element/{tagName}/events
cem://element/{tagName}/css/parts
cem://element/{tagName}/css/custom-properties
cem://element/{tagName}/css/states
```

Also read project-level guidelines for tone and conventions:

```text
cem://guidelines
```

### Phase 1b: Source Comment Syntax

!`cat ${CLAUDE_SKILL_DIR}/html-comment-syntax.md`

### Phase 2: Detect Documentation Conventions

Search the project for existing documentation patterns:

1. Look for existing docs files to match format and structure:
   - Markdown docs in `docs/`, `documentation/`, or alongside source
   - Storybook stories (`*.stories.ts`, `*.stories.js`)
   - README files in component directories
   - JSDoc/TSDoc in source files, including CSS files

2. Match the project's existing doc style:
   - Heading structure and depth
   - Code example format (HTML-only, with JS, framework-specific)
   - Whether docs include live demos or static examples
   - Tone (formal API reference vs conversational guide)

### Phase 3: Generate Documentation

#### Element Overview
- Purpose statement from the manifest description
- When to use this element (and when not to)
- Quick start example showing the simplest useful usage

#### Usage Examples

Generate HTML examples using `generate_html` for:
- **Basic usage**: Minimal attributes, default slot content
- **Common configurations**: Each major attribute combination
- **Slot variations**: Each named slot with appropriate content
- **Composition**: Element used with related elements from the same library

#### Attributes Reference

| Name | Type | Default | Description |
|------|------|---------|-------------|

For enum attributes, include a sub-table or list of valid values with descriptions.

#### Slots Reference

| Name | Description | Content Guidelines |
|------|-------------|--------------------|

Include example HTML showing content in each slot.

#### Events Reference

| Name | Detail | Description |
|------|--------|-------------|

Include JavaScript examples showing how to listen for and handle each event.

#### Styling

**CSS Custom Properties**:

| Property | Default | Description |
|----------|---------|-------------|

**CSS Parts**:

| Part | Description |
|------|-------------|

**CSS States**:

| State | Description |
|-------|-------------|

Include a CSS example showing common customizations.

#### Accessibility

Document any manifest-sourced accessibility patterns:
- ARIA role and keyboard interaction
- Required content for screen readers
- Focus management behavior

### Phase 4: Output Format

Adapt the output format to match what the user needs:

- **Markdown**: Default, suitable for docs sites or READMEs
- **HTML**: If the project uses HTML documentation
- **Storybook**: If stories exist, generate a `*.stories.ts` with knobs for each attribute

Ask the user which format they prefer if it's not clear from context.

## Guidelines

- **Use manifest data as the source of truth**: Don't invent behavior not documented in the manifest
- **Generate working examples**: Call `generate_html` to produce valid HTML, don't hand-write examples that might have errors
- **Match existing tone**: If the project's docs are terse, be terse. If they're tutorial-style, match that
- **Link to related elements**: When composition makes sense, reference other elements from `cem://elements`
- **Mark uncertainty**: If the manifest lacks enough detail for a section, note it rather than guessing
- **Docs feed the manifest**: When writing JSDoc, remember it generates the manifest. Use `@summary` for the short description, `@cssprop` / `@csspart` / `@slot` / `@fires` for API docs. Well-written JSDoc produces a better manifest, which produces better MCP and LSP support.
- **Write MCP-effective descriptions**: Descriptions should be concise, specific, and machine-readable. Avoid vague language. State what the attribute *does*, not just what it *is*. See the CEM guide on effective MCP descriptions.
- **Demo files are docs too**: Each demo should show one variant or feature. Use `<meta itemprop="name">` and `<meta itemprop="description">` for demo metadata. Keep demos self-contained with inline imports.
- **Escape backticks in template HTML comments**: HTML comments inside Lit `html` tagged template literals are used for slot/part docs. Backticks in these comments (e.g. `` `currentColor` ``) break cem's TS transform because they're parsed as template literal boundaries. Escape them with `\`` or avoid them.

Files: 1

Size: 5.1 KB

Complexity: 14/100

Category: Design

Source: https://github.com/bennypowers/cem/tree/main/extensions/claude-code/skills/write-docs

Related in Design

contribute

Included

Local-only OSS contribution command center. Auto-refreshes the user's in-flight PR and issue state on invoke so conversations start with full context — no need to brief Claude on what's in flight. Helps the user find issues to contribute to on GitHub, builds per-repo dossiers of what each upstream expects (CLA, DCO, branch convention, AI policy, draft-first, review bots, issue templates), runs deterministic gates before any external action so AI-assisted contributions don't reach maintainers as slop. State is markdown-only: candidate files at ~/.contribute-system/candidates/, repo dossiers at ~/.contribute-system/research/, append-only event log at ~/.contribute-system/log.jsonl. No database, no cloud calls. Use when the user asks about their PRs / issues / contributions, wants to find new work to take on, claim an issue, build/refresh a repo's dossier, or draft a Design Issue or PR. Trigger with "/contribute", "what's my PR status", "find a contribution", "claim issue X", "draft a Design Issue for Y", "refresh dossier for Z".

Designscripts

architectural-analysis

Included

User-triggered deep architectural analysis of a codebase or scoped subtree across eight modes — information architecture, data flow, integration points, UI surfaces, interaction patterns, data model, control flow, and failure modes. This skill should be used when the user asks to "diagram this codebase," "map the architecture," "show the data flow," "give me an ERD," "trace control flow," "find the integration points," "verify the layout pattern," "audit the UX architecture," or any similar request whose primary deliverable is mermaid diagrams plus cited reports under docs/architecture/. Dispatches haiku/sonnet sub-agents in parallel for per-mode exploration, then verifies every citation mechanically before any node lands in a diagram. Not for one-off prose explanations of code (use code-explanation) or for high-level system design from scratch (use system-design).

Designscripts

mcp

Included

Model Context Protocol (MCP) server development and tool management. Languages: Python, TypeScript. Capabilities: build MCP servers, integrate external APIs, discover/execute MCP tools, manage multi-server configs, design agent-centric tools. Actions: create, build, integrate, discover, execute, configure MCP servers/tools. Keywords: MCP, Model Context Protocol, MCP server, MCP tool, stdio transport, SSE transport, tool discovery, resource provider, prompt template, external API integration, Gemini CLI MCP, Claude MCP, agent tools, tool execution, server config. Use when: building MCP servers, integrating external APIs as MCP tools, discovering available MCP tools, executing MCP capabilities, configuring multi-server setups, designing tools for AI agents.

Designscripts

react-native-skia

Included

Design, build, debug, and optimise high-polish animated graphics in React Native or Expo using @shopify/react-native-skia, Reanimated, and Gesture Handler. Use when the user wants canvas-driven UI, shaders, paths, rich text, image filters, sprite fields, Skottie, video frames, snapshots, web CanvasKit setup, or performance tuning for custom motion-heavy elements such as loaders, hero art, cards, charts, progress indicators, particle systems, or gesture-driven surfaces. Also use when the user asks for fluid, glow, glass, blob, parallax, 60fps/120fps, or GPU-friendly animated effects in React Native, even if they do not explicitly say "Skia". Do not use for ordinary form/layout work with standard views.

Designscripts

plaid

Included

Product Led AI Development — guides founders from idea to launched product. Six capabilities: Idea (discover a product idea), Validate (pressure-test the idea against fatal flaws, problem reality, competition, and 2-week MVP feasibility), Plan (vision intake + document generation), Design (translate image references into a design.md spec), Launch (go-to-market strategy), and Build (roadmap execution). Use when someone says "PLAID", "plaid idea", "help me find an idea", "product idea", "idea from my business", "idea from my expertise", "plaid validate", "validate my idea", "pressure-test", "is this idea good", "find fatal flaws", "validate the problem", "plan a product", "define my vision", "generate a PRD", "product strategy", "plaid design", "design from image", "translate image to design", "create design.md", "extract design tokens", "plaid launch", "go-to-market", "launch plan", "GTM strategy", "launch playbook", "plaid build", "build the app", "start building", or "execute the roadmap".

Designscripts

nextjs-framer-motion-animations

Included

Adds production-safe Motion for React or Framer Motion animations to Next.js apps, including reveal, hover and tap micro-interactions, whileInView, stagger, AnimatePresence, layout and layoutId transitions, reorder, scroll-linked UI, and lightweight route-content transitions. Use when the user asks to add, refactor, or debug Motion or Framer Motion in App Router or Pages Router codebases, especially around server/client boundaries, reduced motion, LazyMotion, bundle size, hydration, or route transitions. Avoid for GSAP-style timelines, WebGL or 3D scenes, heavy scroll storytelling, or CSS-only effects unless Motion is explicitly requested.

Designscripts