docs-write — Claude Code skill: what it does, how to install
This skill helps write and edit Markdown and MDX in Metabase’s style. Use it when a documentation file needs a clear structure, checked examples, and consistent formatting.
npx skills add metabase/metabase --skill docs-write -a claude-codeWhat docs-write does
docs-write guides documentation work from the reader’s task to the final edit. It helps an agent put the action first, choose headings that state the point, remove text that does not help, and review examples before they go into a file. The skill applies to Markdown, MDX, and similar documentation files.
It points to metabase-style-guide.md and allows Read, Write, Grep, Bash, and Glob. The workflow also includes bun run prettier --write <file-path> for formatting. The Claude Code install list repeats the same command, so check the resulting skill file after setup.
What it helps with
- write Markdown and MDX documentation
- turn vague headings into action-focused headings
- check commands and links in documentation examples
- format a file with the Metabase writing style
Example prompts for the agent
- Write `README.md` in the Metabase style, starting with the actions a reader needs to take.
- Edit `docs/setup.mdx` so the instructions lead with the action and the command examples work.
- Review headings, links, and formatting in `docs/guide.md`, then run `bun run prettier --write docs/guide.md`.
How to install docs-write
1Skills CLI (Vercel)
npx skills add metabase/metabase --skill docs-write -a claude-code2Manually: put the files in place
~/.claude/skills/docs-write/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/docs-write/
1Skills CLI (Vercel)
npx skills add metabase/metabase --skill docs-write -a codex2Manually: put the files in place
.agents/skills/docs-write/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add metabase/metabase --skill docs-write -a cursor2Manually: put the files in place
.cursor/skills/docs-write/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install metabase/metabase docs-write2Manually: put the files in place
.github/skills/docs-write/SKILL.md1Skills CLI (Vercel)
npx skills add metabase/metabase --skill docs-write -a gemini-cli2Platform CLI
gemini skills install https://github.com/metabase/metabase --path .claude/skills/docs-writeManually: put the files in place
.devin/skills/docs-write/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add metabase/metabase --skill docs-write -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
From the same set6
The whole set →Similar
Questions about docs-write
How do I install docs-write in Claude Code?
Run these steps in order: npx skills add metabase/metabase --skill docs-write -a claude-code, then run the same command again: npx skills add metabase/metabase --skill docs-write -a claude-code. Finally, check ~/.claude/skills/docs-write/SKILL.md.
What does docs-write do?
It guides an agent through writing and editing Markdown or MDX documentation. It covers structure, headings, links, examples, and the Metabase writing style.
Which tools can docs-write use?
The skill has access to Read, Write, Grep, Bash, and Glob. Its formatting step uses bun run prettier --write <file-path>.
