skills.rest
Hieubkav
HieubkavCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

docs-write

Write and edit Markdown and MDX documentation following Metabase style guidelines.

Updated Feb 23, 2025
Search Tags:#documentation#writing#markdown#consistency#mdx#tone-consistency#metabase-style
One-click install
npx skills add https://github.com/Hieubkav/Ph-ng-Kh-m-Ng-c-Nh-n --skill docs-write-hieubkav
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-write
Source: https://github.com/Hieubkav/Ph-ng-Kh-m-Ng-c-Nh-n/tree/main/.claude/skills/docs-write
Command: npx skills add https://github.com/Hieubkav/Ph-ng-Kh-m-Ng-c-Nh-n --skill docs-write-hieubkav

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Write documentation that is clear, user-focused, and aligned with Metabase's style, reducing revisions and improving accessibility.

Core Features & Use Cases

  • Consistent Metabase-style tone and structure across Markdown and MDX docs.
  • Quick guidelines for writing, editing, and formatting, including examples.
  • Use Case: creating new guides or updating existing docs to meet Metabase's documentation standards.

Quick Start

Write concise, reader-focused documentation that mirrors Metabase's style.

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 matches Metabase style guidelines?▼

To write documentation matching Metabase style, author or edit Markdown and MDX files focusing on clear, user-focused content. This ensures your guides, tutorials, and API references maintain consistent tone and high example quality.

What is the best way to ensure tone consistency across Markdown documentation?▼

The best way to ensure tone consistency across Markdown documentation is to apply standardized style guidelines during authoring and editing. This approach enforces uniform frontmatter presence, formatting, and tone across all guides and API references.

Does this approach work for editing existing MDX docs?▼

Yes, this approach works for editing existing MDX docs. You can update current guides and tutorials to satisfy frontmatter presence, tone consistency, and formatting requirements, aligning them with Metabase documentation standards.

Can I use this to format API references in Markdown?▼

Yes, you can use this to format API references in Markdown. The process enforces strict formatting, tone consistency, and example quality guidelines, ensuring your technical API documentation remains clear and user-focused.

When do I need frontmatter presence checks for MDX files?▼

You need frontmatter presence checks for MDX files when standardizing documentation for publishing. Verifying frontmatter ensures your guides and tutorials meet structural requirements and maintain consistent metadata across the entire documentation base.

Related Skills

Explore More Content & Communication Skills→
sefllessseflless

write-docs

Create MDX documentation for tldark's SDK in apps/docs/content/ with frontmatter and guides.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
lbliiilbliii
41

bengal-content-migration

Migrates static site and Markdown content to Bengal format.

Community
Intermediate
joshkellett87joshkellett87

docs-write

Format Markdown and MDX docs with Metabase style using Prettier.

Community
Basic