docs-write

Name: docs-write
Rating: 5 (44733 reviews)
Author: metabase

Write documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.).

TL;DR

Write clear, user-focused docs using conversational tone and actionable steps.

What Is It

Documentation style matching Metabase's conversational tone
Audience-aware complexity and fast answers
Action-first, explanation-second writing
User-focused, not feature-focused

Key Features

Start with what to do, then explain why
Use descriptive headings like 'Set SAML before adding users'
Link with context like 'Check out the SAML docs' not 'click here'
Write as if talking to a colleague
Examples must work and be relevant
Use bold for UI elements, backticks for code
American spelling, serial commas, minimal images

How to Use

1.Draft steps as you'd explain to a colleague
2.Edit by reading aloud and cutting irrelevant content
3.Polish with clear links, correct formatting, and working examples
4.Run prettier after edits for consistency

Guardrails & Gotchas

Never describe tasks as 'easy'
Avoid 'we' when talking about Metabase features
No formal language like 'utilize', 'reference', 'offerings'
No multiple exclamation points
No burying action in explanation
No code examples that don't work
No numbers that will become outdated

GitHub Stats

Author

@metabase

Repository

metabase/metabase

Stars

44733

Explore More Skills

move-code-quality

@davila7

Analyzes Move language packages against the official Move Book Code Quality Checklist. Use this skill when reviewing Move code, checking Move 2024 Edition compliance, or analyzing Move packages for best practices. Activates automatically when working with .move files or Move.toml manifests.

12.4k

1.1k

1w ago

docs-write

Explore More Skills

move-code-quality

e2e-testing-patterns

testing-anti-patterns