What is the docs-write skill?

It is a specialized capability for Claude Code designed to help users write and edit documentation in a clear, conversational style inspired by Metabase's public documentation.

What is the primary tone of the documentation it produces?

It produces a conversational, 'colleague-to-colleague' tone that avoids overly formal language like 'utilize' or 'reference' in favor of simpler words.

Does it handle code formatting?

Yes, it enforces the use of backticks for code and variables, and it can run Prettier via the command line to ensure consistent file formatting.

What file types does this skill support?

The skill is optimized for documentation files including Markdown (.md) and MDX (.mdx) formats.

How does it handle UI elements?

It uses bold text specifically for UI elements (like buttons) to distinguish them from code snippets or general text, making guides easier to navigate visually.

Metabase-Style Documentation Writer

Name: Metabase-Style Documentation Writer
Author: Activer007

byActiver007

•

学习与文档

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

The docs-write skill empowers Claude to create and refine documentation that is clear, approachable, and highly structured. It follows a specific philosophy inspired by Metabase, prioritizing the reader's needs by leading with actions, using conversational language, and avoiding formal jargon. The skill ensures technical accuracy by verifying examples and maintains visual consistency by enforcing specific Markdown formatting rules, American English spelling, and automatic code prettification. It is particularly useful for developers and technical writers who want to transform dry, technical manuals into engaging, easy-to-follow guides.

主要功能

018 GitHub stars

02Conversational tone enforcement

03Strict UI and code element styling

04Audience-aware complexity mapping

05Action-oriented heading structures

06Automatic Prettier formatting for Markdown

使用场景

01Refactoring existing documentation for better readability

02Standardizing documentation style across a large codebase

03Authoring new user guides and technical tutorials

What are Skills?·How to Install

Install with 🐟 Skill.Fish

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

For use in Claude.ai and ChatGPT

Download Skill