無料GitHub で公開

docs-write

Write documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.).

foryourhealth111-pixel/Vibe-Skills

インストール方法を見る

含まれるファイル（1）

SKILL.md2.8 KB

SKILL.md（原文）

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Documentation Writing Skill

@./../_shared/metabase-style-guide.md

When writing documentation

Start here

Who is this for? Match complexity to audience. Don't oversimplify hard things or overcomplicate simple ones.
What do they need? Get them to the answer fast. Nobody wants to be in docs longer than necessary.
What did you struggle with? Those common questions you had when learning? Answer them (without literally including the question).

Writing process

Draft:

Write out the steps/explanation as you'd tell a colleague
Lead with what to do, then explain why
Use headings that state your point: "Set SAML before adding users" not "SAML configuration timing"

Edit:

Read aloud. Does it sound like you talking? If it's too formal, simplify.
Cut anything that doesn't directly help the reader
Check each paragraph has one clear purpose
Verify examples actually work (don't give examples that error)

Polish:

Make links descriptive (never "here")
Backticks only for code/variables, bold for UI elements
American spelling, serial commas
Keep images minimal and scoped tight

Format:

Run prettier on the file after making edits: yarn prettier --write <file-path>
This ensures consistent formatting across all documentation

Common patterns

Instructions:

Run:
\`\`\`
command-to-run
\`\`\`

Then:
\`\`\`
next-command
\`\`\`

This ensures you're getting the latest changes.

Not: "(remember to run X before Y...)" buried in a paragraph.

Headings:

"Use environment variables for configuration" ✅
"Environment variables" ❌ (too vague)
"How to use environment variables for configuration" ❌ (too wordy)

Links:

"Check out the SAML documentation" ✅
"Read the docs here" ❌

Watch out for

Describing tasks as "easy" (you don't know the reader's context)
Using "we" when talking about Metabase features (use "Metabase" or "it")
Formal language: "utilize", "reference", "offerings"
Too peppy: multiple exclamation points
Burying the action in explanation
Code examples that don't work
Numbers that will become outdated

Quick reference

Write This	Not This
people, companies	users
summarize	aggregate
take a look at	reference
can't, don't	cannot, do not
Filter button	`Filter` button
Check out the docs	Click here

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

ログインしてレビューを書く

同じリポジトリのスキル

概要と使いどころ

adaptyv

無料

Cloud laboratory platform for automated protein testing and validation. Use when designing proteins and needing experimental validation including binding assays, expression testing, thermostability measurements, enzyme activity assays, or protein sequence optimization. Also use for submitting experiments via API, tracking experiment status, downloading results, optimizing protein sequences for better expression using computational tools (NetSolP, SoluProt, SolubleMPNN, ESM), or managing protein design workflows with wet-lab validation.

日本語の概要は準備中です。原文の説明を表示しています。