What formatting standards does this skill follow?

It follows Metabase's specific style guide, which includes American spelling, bolding for UI elements, backticks for code variables, and mandatory Prettier formatting.

Does this skill handle MDX files?

Yes, it is designed to work with various documentation formats including standard Markdown (.md) and MDX (.mdx) files commonly used in modern documentation stacks.

How does it improve documentation quality?

The skill enforces a conversational tone, avoids overly formal jargon, ensures examples are functional, and structures instructions to be action-first rather than explanatory-heavy.

Can it automatically format my documentation files?

Yes, it includes a polishing step that runs 'yarn prettier --write' on the modified files to ensure consistent formatting across the entire repository.

Metabase Documentation Writer

Name: Metabase Documentation Writer
Author: metabase

bymetabase

•

45,683

•

Learning & Documentation

Writes and edits documentation following the Metabase conversational, clear, and user-focused style guidelines.

This skill empowers Claude to create and maintain documentation that aligns with Metabase's specific editorial standards, ensuring all content is accessible and professional. It guides the writing process from initial drafting to final polishing, focusing on audience-appropriate complexity, action-oriented headings, and consistent formatting. By automating the application of the Metabase style guide and running Prettier for syntax consistency, this skill helps developers produce high-quality Markdown and MDX files that prioritize the reader's needs and technical clarity.

Key Features

01Automated Prettier formatting for Markdown and MDX

02Action-oriented heading and instruction patterns

03Conversational and user-focused writing style

04Audience-targeted complexity management

05Standardized UI element and code block styling

0645,683 GitHub stars

Use Cases

01Creating clear, step-by-step troubleshooting instructions for end users

02Refactoring existing documentation to match the official style guide

03Drafting new feature guides and technical tutorials for Metabase

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add metabase/metabase docs-write

For use in Claude.ai and ChatGPT

Download Skill