docs-write

Write and edit markdown and MDX documentation following Metabase style guidelines.

1|Updated Feb 6, 2026
One-click install
npx skills add https://github.com/bradoctech/metabase --skill docs-write-bradoctech
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-write
Source: https://github.com/bradoctech/metabase/tree/main/.claude/skills/docs-write
Command: npx skills add https://github.com/bradoctech/metabase --skill docs-write-bradoctech

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps users write clear, concise, and user-focused documentation that adheres to the Metabase style guide, ensuring consistency and readability.

Core Features & Use Cases

  • Style Adherence: Guides users to follow Metabase's specific writing conventions for tone, structure, and formatting.
  • Process Guidance: Provides a step-by-step process for drafting, editing, and polishing documentation.
  • Use Case: A new feature is ready for documentation. Use this Skill to write the new help pages, ensuring they are easy to understand for end-users and follow the established Metabase style.

Quick Start

Write documentation for the new dashboard filtering feature following the Metabase style guide.

Frequently Asked Questions about docs-write

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write documentation that follows the Metabase style guide?

Writing Metabase-style documentation requires following a structured process of drafting, editing, and polishing markdown or MDX files. This ensures content remains conversational, clear, user-focused, and adheres to established formatting rules.

What is the best way to edit existing markdown files for a Metabase audience?

Editing markdown files for a Metabase audience involves applying specific style guidelines for clarity and conciseness. You refine the content through a polishing process to ensure the tone remains conversational and user-focused.

Can I use this approach to create MDX documentation for new features?

Yes, this approach applies to creating MDX documentation for new features. It guides you through writing help pages that are easy for end-users to understand while strictly adhering to Metabase writing conventions.

Does Metabase documentation require a specific writing process?

Metabase documentation requires a specific writing process that includes drafting, editing, and polishing. This structured workflow ensures all content meets style guidelines for audience appropriateness, clarity, and conciseness.

What tone should I use when writing Metabase help pages?

When writing Metabase help pages, you should use a conversational, clear, and user-focused tone. This ensures the documentation is accessible and easy to understand for end-users reading the markdown content.