What is the Metabase documentation style?

It is a writing approach that prioritizes a conversational tone, clear headings, and user-centric instructions while avoiding overly formal or 'peppy' language.

Does this skill support MDX files?

Yes, the skill is designed to work with both standard Markdown (.md) and MDX files commonly used in modern documentation frameworks.

How does it handle document formatting?

The skill includes instructions to run Prettier on files after editing to ensure consistent indentation and styling across the entire project.

Why does it avoid words like 'easy' or 'utilize'?

It avoids 'easy' to remain objective regarding the reader's skill level and replaces formal words like 'utilize' with simpler alternatives like 'use' to improve readability.

Metabase-Style Documentation Assistant

Name: Metabase-Style Documentation Assistant
Author: Microck

byMicrock

•

132

•

学习与文档

Writes and edits technical documentation following the conversational, user-focused Metabase style guide.

This skill empowers Claude to create and refine documentation that is clear, approachable, and highly functional by adopting the Metabase style guide principles. It focuses on matching complexity to the audience, using action-oriented headings, and ensuring all code examples are accurate and functional. Whether generating new Markdown files or auditing existing MDX content, this skill helps eliminate formal jargon, enforces American English standards, and ensures consistent formatting through Prettier, making technical docs feel like a helpful conversation with a colleague.

主要功能

01Validates that code examples are clear, functional, and properly formatted

02Enforces a conversational, peer-to-peer writing tone for technical content

03Optimizes document structure with action-oriented headings and descriptive links

04Standardizes language usage including American spelling and serial commas

05Automates consistent formatting using Prettier for Markdown and MDX files

06132 GitHub stars

使用场景

01Writing step-by-step tutorials that prioritize immediate user actions over theory

02Converting overly formal technical specifications into user-friendly help articles

03Auditing existing documentation for style consistency and outdated terminology

What are Skills?·How to Install

Install with 🐟 Skill.Fish

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

For use in Claude.ai and ChatGPT

Download Skill