Can this skill format my Markdown files?

Yes, the skill includes patterns for running Prettier to ensure consistent formatting and layout across your entire documentation suite.

Does it support modern documentation frameworks?

Absolutely. It is designed to work with standard Markdown and MDX files used in tools like Docusaurus, Nextra, and GitBook.

What is the Metabase style guide?

It is a set of principles that favors conversational, clear, and user-focused documentation over overly formal or academic technical writing.

How does this skill improve user experience?

It focuses on getting users to answers faster by using descriptive headings, removing 'peppy' or formal filler, and ensuring all code examples are functional.

Why does it avoid terms like 'utilize'?

The skill follows the philosophy of using simple, direct language (like 'use' instead of 'utilize') to keep documentation accessible to all levels of readers.

Documentation Writing Style

Name: Documentation Writing Style
Author: TerryTong-Git

byTerryTong-Git

内容管理

Writes and edits user-focused documentation following a conversational style guide to ensure technical content is clear and accessible.

关于

This skill enables Claude to author and refine documentation files (Markdown, MDX) by adhering to the Metabase style guide, which emphasizes a reader-first approach. It focuses on matching complexity to the target audience, using action-oriented headings, and maintaining a professional yet conversational tone. By prioritizing direct answers over dense explanations and enforcing consistent formatting via tools like Prettier, this skill helps developers create high-quality guides that users actually enjoy reading.

主要功能

0 GitHub stars
Enforces American spelling, serial commas, and specific UI element bolding
Implements action-oriented heading structures for better scannability
Integrates with Prettier for automated documentation formatting
Adheres to Metabase conversational style standards for technical writing
Validates code examples and CLI command patterns for accuracy

使用场景

Editing existing documentation to remove formal jargon and improve clarity
Transforming complex technical specifications into user-friendly how-to guides
Standardizing a project's documentation voice and formatting across multiple MDX files

关于

主要功能

0 GitHub stars
Enforces American spelling, serial commas, and specific UI element bolding
Implements action-oriented heading structures for better scannability
Integrates with Prettier for automated documentation formatting
Adheres to Metabase conversational style standards for technical writing
Validates code examples and CLI command patterns for accuracy

使用场景

Editing existing documentation to remove formal jargon and improve clarity
Transforming complex technical specifications into user-friendly how-to guides
Standardizing a project's documentation voice and formatting across multiple MDX files