docs-write
Write documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.).
Security Assessment
About docs-write
The 'docs-write' skill is designed to assist users in creating and editing documentation that adheres to Metabase's clear, conversational, and user-focused writing style. It addresses the common challenges faced by writers when trying to convey complex information in an accessible manner, ensuring that documentation is not only informative but also engaging and easy to navigate. By following a structured approach, this skill helps streamline the documentation process, making it more efficient and effective for users.
This skill features a comprehensive writing process that includes drafting, editing, and polishing documentation. It emphasizes clarity and conciseness, guiding users to focus on their audience's needs while providing practical examples and actionable instructions. The skill also highlights common patterns and pitfalls to avoid, such as using overly formal language or vague headings. Additionally, it provides formatting guidelines to ensure consistency across documentation files, making them visually appealing and easy to read.
Target users for the 'docs-write' skill include technical writers, product managers, and developers who are responsible for creating or maintaining documentation for Metabase. Whether they are crafting new documentation or refining existing content, this skill serves as a valuable resource to enhance their writing quality and improve user comprehension, ultimately leading to a better user experience with Metabase's products.
FAQ
How do I start using the docs-write skill?
Begin by following the guidelines outlined in the documentation writing process, focusing on clarity and audience needs.
What tools are required for this skill?
The allowed tools include Read, Write, Grep, Bash, and Glob.
Can I use this skill for documentation formats other than markdown?
This skill is specifically designed for markdown, MDX, and similar documentation formats.
Are there any specific requirements for using this skill?
Ensure you have a basic understanding of the documentation style guide and follow the outlined writing processes.
What should I avoid when using this skill?
Avoid using overly formal language, vague headings, and including non-functional code examples.
Install docs-write
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
metabase/metabase