docs-write

Guides writing and editing Markdown/MDX documentation according to Metabase's style guide.

Updated Jan 6, 2026
One-click install
npx skills add https://github.com/Kidoz-SDK/metabase --skill docs-write-kidoz-sdk
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-write
Source: https://github.com/Kidoz-SDK/metabase/tree/main/.claude/skills/docs-write
Command: npx skills add https://github.com/Kidoz-SDK/metabase --skill docs-write-kidoz-sdk

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps users write clear, concise, and user-focused documentation that adheres to Metabase's specific style guide, ensuring consistency and readability.

Core Features & Use Cases

  • Style Adherence: Guides users to follow Metabase's conversational, clear, and user-focused writing style.
  • Process Guidance: Provides a structured writing, editing, and polishing process.
  • Formatting Enforcement: Ensures consistent formatting through tools like Prettier.
  • Use Case: A new feature is being added to Metabase, and the team needs to write comprehensive documentation for it. This Skill will guide the writer through the process, ensuring the documentation is accurate, easy to understand, and matches the existing Metabase style.

Quick Start

Use the docs-write skill to draft documentation for the new user authentication flow.

Frequently Asked Questions about docs-write

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

FAQPage Schema
How do I write documentation that follows a consistent style guide?

To write documentation that follows a consistent style guide, use a structured writing and editing process that enforces conversational tone, user-focused clarity, and consistent markdown formatting through tools like Prettier.

What is the best way to format markdown and MDX files for user-focused docs?

The best way to format markdown and MDX files for user-focused docs is to apply automated formatting tools like Prettier alongside a structured editing process, ensuring your content remains clear, concise, and consistently styled.

How do I structure the editing process for new feature documentation?

Structure the editing process for new feature documentation by following a guided sequence: draft the content, apply conversational and user-focused style guidelines, then polish and enforce consistent markdown or MDX formatting.

Can I use Prettier to enforce documentation style guidelines in markdown files?

Yes, you can use Prettier to enforce documentation style guidelines in markdown files. It ensures consistent formatting across your markdown and MDX content, while a guided writing process handles the conversational tone and clarity.

Why does my markdown documentation style feel inconsistent across different pages?

Markdown documentation style feels inconsistent across different pages when it lacks a structured writing process and automated formatting enforcement. Applying a specific user-focused style guide and tools like Prettier ensures consistent readability and tone.