docs-write

Enforce Metabase style guide rules for markdown and MDX documentation.

4|2|Updated Jan 16, 2026

Search Tags:#documentation #writing #markdown #consistency #editing #style-guide

Ready to run

npx skills add https://github.com/PeterFile/my-common-skills --skill docs-write-peterfile

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Eliminates unclear and inconsistent documentation by enforcing a defined style guide.

Core Features & Use Cases

Guided writing: Adheres to Metabase's conversational tone and structure for markdown/MDX docs.
Style conformance: Enforces Metabase's style guide for tone, structure, and formatting.
Editing workflows: Provides actionable steps for drafting, editing, and polishing docs.
Use Case: When creating onboarding docs, API refs, or knowledge base articles, use this Skill to maintain consistency across docs.

Quick Start

Run the docs-write skill to draft a quick onboarding guide for a new product feature.

Frequently Asked Questions about docs-write

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

FAQPage Schema

How do I enforce a style guide when writing markdown documentation?▼

You can enforce a style guide for markdown documentation by applying predefined formatting rules, tone guidelines, and templates to automatically eliminate unclear and inconsistent writing.

What's the best way to maintain consistency across API references and onboarding guides?▼

Maintain consistency across API references and onboarding guides by using a guided editing workflow that enforces a conversational tone, structural formatting rules, and specific style templates.

How do I draft knowledge base articles that follow a consistent tone?▼

Draft knowledge base articles with a consistent tone by following actionable steps for drafting, editing, and polishing docs while conforming to defined style guide rules for markdown and MDX formats.

Does this documentation writing approach work for scaling content creation?▼

Yes, this approach works for scaling content creation by enforcing a defined style guide across onboarding docs, API references, and knowledge base articles to ensure clarity and consistency at scale.

Can I use this to format MDX docs according to specific style guidelines?▼

Yes, you can format MDX docs according to specific style guidelines by applying the enforced tone, structure, and formatting rules defined in the style guide references.

Why does my documentation have inconsistent formatting and tone?▼

Documentation has inconsistent formatting and tone when it lacks an enforced style guide, which this approach solves by applying predefined templates and formatting rules during the writing and editing workflow.