# Write Clear Metabase Documentation

Technical documentation often becomes formal, vague, or difficult to scan. This skill helps Claude, Codex, and Claude Code write clear Metabase documentation with focused steps.

## Install

```bash
npx skillstore add metabase/docs-write
```

## Metadata

- Status: approved
- Slug: metabase-docs-write
- Skillstore revision: r2
- Version status: missing
- Tree hash: eda1f4fce9aee7ef08d466e40dfc64b797e4d878216f83b98c0bad6d6bee5fac
- Author: metabase
- GitHub username: metabase
- License: MIT
- Repository: https://github.com/metabase/metabase/tree/master/.claude/skills/docs-write
- Ref: ebdfe608f5de2b66ff37ab4af12af8ac4f5e8006
- Supported tools: Claude, Codex, Claude Code
- Audit status: complete
- Agent install advisory: allowed
- Manual install advisory: allowed
- Artifact signature: available
- Audit attestation: unavailable
- Human verification: not\_verified
- Risk factors: external\_commands, filesystem
- Quality score: 79
- Quality tier: bronze
- Public page: https://skillstore.pages.dev/skills/metabase-docs-write
- Manifest: https://skillstore.pages.dev/api/skills/metabase-docs-write/manifest

## Capabilities

- Drafts and edits Markdown or MDX documentation for Metabase.
- Leads with actions before explaining reasons or context.
- Creates descriptive headings that state the main point.
- Formats links, code terms, and interface labels consistently.
- Applies a repository formatter after documentation edits.

## Use Cases

- Draft Feature Documentation: Turn verified feature details into a focused guide with clear steps and expected results.
- Improve Product Guides: Rewrite dense or formal documentation so customers can find and complete tasks faster.
- Standardize Documentation Changes: Apply Metabase wording, formatting, and heading conventions during code-related documentation updates.

## Prompt Templates

### Draft a Short Page

```
Draft a short Metabase documentation page for [feature]. Explain the audience, prerequisites, steps, and expected result in clear Markdown.
```

### Rewrite Existing Documentation

```
Rewrite the following documentation in Metabase style: [text]. Lead with actions, simplify formal language, and use descriptive headings and links.
```

### Build a Task Guide

```
Create a task guide for [workflow] using these verified details: [details]. Separate each action from its explanation and format interface labels in bold.
```

### Audit and Revise a Page

```
Audit [file] for Metabase style, clarity, structure, link text, interface formatting, and working examples. Revise it, summarize material changes, then run the repository formatter.
```

## Limitations

- The referenced shared style guide must exist at the expected relative path.
- The skill cannot guarantee technical accuracy without reliable project context.
- The guidance is specialized for Metabase documentation conventions.
- Formatting requires Bun and the repository dependencies.

## Best Practices

- Provide verified product details, audience needs, and prerequisites.
- Review every example and link before publishing.
- Run the repository formatter after content changes.

## Anti Patterns

- Do not bury required actions inside long explanatory paragraphs.
- Do not use vague headings or generic link labels.
- Do not describe tasks as easy or include facts that will quickly expire.

## Security Audit

- Audited at: 2026-07-23T17:29:28.91\+00:00
- Summary: All nine static findings are false positives. Seven command findings are Markdown syntax or a standard local Prettier command, while the fixed parent reference loads a shared style guide. Line 17 contains a writing question, and no malicious intent, prompt injection, exfiltration, or unsafe dynamic input was found.

## Stats

- Views: 198
- Downloads: 11
- Favorites: 0
- Popularity score: 0