Description
docs-write is an agent skill that helps write documentation in Metabase's conversational, clear and user-focused style. It applies when creating or editing documentation files, such as markdown and MDX. The skill starts with three questions: who the reader is, so the complexity matches the audience; what they need, so they reach the answer quickly; and what you struggled with when you learned the subject, so you can answer those common questions without quoting them. Its writing process starts with a draft written as you would explain the steps to a colleague. It says to lead with what to do and then explain why, and to write headings that state a point, such as setting SAML before adding users, rather than a vague topic label. The skill loads the shared Metabase style guide. It is for people writing or editing the Metabase documentation in the metabase/metabase repository, and the listing shows it as free. It has about 2,100 installs, and its security audits show passes from Gen Agent Trust Hub, Socket and Snyk. Install it with npx skills add https://github.com/metabase/metabase --skill docs-write.…
Highlights
- Writes documentation in Metabase's clear style
- Starts from audience, need and common questions
- Leads with what to do, then why
- Headings that state a point
- Loads the shared style guide
Ratings & Reviews
No ratings yet
Be the first to rate docs-write.
People also visit
docs-write FAQ
What does the skill do?
It helps you write or edit documentation files, such as markdown and MDX, in Metabase's style.
What questions does it ask first?
Who the reader is, what they need, and what you struggled with when you learned the subject.
How should the steps be written?
The skill says to lead with what to do and then explain why, and to write headings that state the point.
Who is it for?
People writing or editing the Metabase documentation.
How do I install it?
Run npx skills add https://github.com/metabase/metabase --skill docs-write.
Is it checked for security?
Its security audits show passes from Gen Agent Trust Hub, Socket and Snyk.
What are the best docs-write alternatives?
Popular alternatives to docs-write include write-openspec-docs, docs-review and draft-openspec-docs. See all docs-write alternatives