Writes clear, user-focused technical documentation following a conversational and action-oriented style guide.
The Documentation Writing Pro skill empowers Claude to produce high-quality Markdown and MDX documentation that prioritizes the reader's needs. Inspired by the Metabase style guide, it replaces formal, passive language with a conversational tone and direct instructions. This skill ensures that headings are descriptive, links are contextually relevant, and code examples are functional, while also managing formatting through tools like Prettier to maintain consistency across entire document sets.
Key Features
010 GitHub stars
02Enforces a conversational, user-focused technical writing style
03Standardizes Markdown and MDX formatting according to best practices
04Filters out formalisms and 'fluff' to improve clarity
05Integrates Prettier for automated document styling
06Generates action-oriented headings for improved scannability
Use Cases
01Creating step-by-step tutorials and user guides for software projects
02Refactoring existing technical documentation to be more concise and readable
03Standardizing the voice and tone across large open-source documentation repositories
