Does it support MDX files?

Yes, the skill is designed to work with various documentation formats including standard Markdown and MDX.

How does it improve readability?

It prioritizes action-oriented headings, replaces complex words like 'utilize' with 'use', and structures instructions to be task-first.

Can I use this for non-Metabase projects?

Absolutely; while based on the Metabase style, these principles are excellent for any project requiring high-quality, approachable, and professional documentation.

What is the Metabase style guide?

It is a set of documentation principles focusing on clear, conversational, and user-centric writing that avoids formal jargon and gets users to answers quickly.

Does this skill handle markdown formatting?

Yes, it includes instructions to run Prettier and ensures consistent use of bolding for UI elements and backticks for code variables.

Metabase Style Documentation Writer

Name: Metabase Style Documentation Writer
Author: Activer007

byActiver007

•

Content Management

Writes user-centric, conversational technical documentation following the Metabase style guide for clear and accessible communication.

This skill enables Claude to author and edit technical documentation using the Metabase style guide, focusing on clarity, conversational tone, and user-centered communication. It streamlines the creation of markdown or MDX files by emphasizing active headings, task-oriented instructions, and consistent formatting through integrated tools like Prettier. Ideal for developers and technical writers who want to transform complex technical concepts into approachable, easy-to-read guides that prioritize the reader's immediate needs over formal jargon.

Key Features

01Enforces specific styling rules for UI elements, code snippets, and descriptive links

02Automatically ensures consistent markdown formatting using Prettier

036 GitHub stars

04Implements Metabase's conversational and user-focused writing style

05Optimizes documentation hierarchy with action-oriented headings

06Refines technical language by replacing formal jargon with simple alternatives

Use Cases

01Drafting new user-facing guides that sound human and approachable

02Refactoring existing technical docs to remove passive voice and formal jargon

03Standardizing documentation formatting and link styles across a large project

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add activer007/ordinary-claude-skills docs-write

For use in Claude.ai and ChatGPT

Download Skill