docs-write

Format Markdown and MDX docs with Metabase style using Prettier.

Updated Jan 14, 2026

Search Tags:#documentation #writing #markdown #formatting #mdx #style-guide

Ready to run

npx skills add https://github.com/joshkellett87/useful-skills --skill docs-write-joshkellett87

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-write
Source: https://github.com/joshkellett87/useful-skills/tree/main/docs-write
Command: npx skills add https://github.com/joshkellett87/useful-skills --skill docs-write-joshkellett87

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation writing is often inconsistent and hard to follow. This skill provides a clear, user-focused approach aligned with Metabase style to standardize doc creation and editing across Markdown, MDX, and related formats.

Core Features & Use Cases

Style guidance for Markdown, MDX, and related documentation formats.
Guidance on structure, headings, links, and examples to improve readability and maintainability.
Use Case: when creating or updating product documentation, onboarding guides, or API references, apply the style guidelines to ensure consistency and clarity.

Quick Start

Create or update a documentation file following the Metabase style guide, then run yarn prettier --write <file-path> to format it.

Frequently Asked Questions about docs-write

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

FAQPage Schema

How do I format Markdown documentation to ensure consistent typography and headings?▼

To format Markdown documentation consistently, you can apply a style guide to your draft and run a formatter like prettier. This standardizes typography, headings, links, and code formatting for user-focused docs.

What is the best way to write user-focused product documentation in MDX?▼

The best way to write user-focused product documentation in MDX is to apply a standardized style guide during creation and editing, followed by automated formatting to ensure clarity and structural consistency.

Does this approach work for onboarding guides and API references?▼

Yes, this approach works for onboarding guides and API references. Applying style guidelines to these documentation types ensures standard structure, readable examples, and consistent formatting across various product materials.

Do I need prettier to format MDX files with a style guide?▼

Yes, you need prettier to format MDX files with a style guide. Running prettier ensures consistent typography, headings, links, and code formatting across your documentation after applying the style guidelines.

Why standardize documentation formatting across Markdown files?▼

Standardizing documentation formatting across Markdown files prevents inconsistent and hard-to-follow docs. Applying a user-focused style guide improves readability, structure, and maintainability across all product documentation.