Agent skill

Docs Write

by tmcfarlane in tmcfarlane/oh-my-cursor

Write documentation following Metabase's conversational, clear, and user-focused style.

MITAuto-check: notesDocuments & Office

Install Docs Write

skills CLI
$ npx skills add tmcfarlane/oh-my-cursor --skill docs-write -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install tmcfarlane/oh-my-cursor docs-write --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/tmcfarlane/oh-my-cursor.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/docs-write .claude/skills/docs-write && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs-write
GitHub stars
110
Used in
3 other repos
Token cost
~716 tokens
SKILL.md length
307 words
Files
1
Skills in repo
14
Repo updated
First seen
Licence
MIT

At a glance

Write documentation following Metabase's conversational, clear, and user-focused style.

  • Works in 3 steps: Who is this for? Match complexity to… → What do they need? Get them to the… → What did you struggle with? Those common…
  • Editing documentation files (markdown
  • Calls bun
  • Tasks that involve Markdown

What it does

Docs Write is an agent skill from tmcfarlane/oh-my-cursor. Write documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.).

Its SKILL.md is about 720 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Documents & Office, covering Markdown. The repository describes itself as: Like “oh-my-opencode”, but for Cursor IDE. Multi-agent orchestration, natively, using nothing but a few config files. The licence is MIT.

When your agent uses it

  • Editing documentation files (markdown
  • Tasks that involve Markdown

Example prompts

  • “/docs-write”

Requirements

  • Pre-approved tools (allowed-tools): Read, Write, Grep, Bash, Glob

Workflow steps

3 steps, taken from the first numbered list in SKILL.md.

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

What it can do on your machine

Read from SKILL.md and the folder at commit 5bad458. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Read
    • Write
    • Grep
    • Bash
    • Glob

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • bun

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Docs Write loads about 716 tokens when it runs. Until then it costs about 43 tokens; SKILL.md has 307 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~43
When it runs · the whole SKILL.md, loaded when a task matches
~716

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NotePre-approves every shell command (allowed-tools: Bash)SKILL.md
    allowed-tools: Read, Write, Grep, Bash, Glob

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from tmcfarlane/oh-my-cursor at commit 5bad458, republished under its MIT licence (© tmcfarlane). 307 words, ~716 tokens.

Download SKILL.mdSave it as .claude/skills/docs-write/SKILL.md (or your agent's skills folder).
name
docs-write
description
Write documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.).
allowed-tools
Read, Write, Grep, Bash, Glob

Documentation Writing Skill

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

When writing documentation

Start here
  1. Who is this for? Match complexity to audience. Don't oversimplify hard things or overcomplicate simple ones.
  2. What do they need? Get them to the answer fast. Nobody wants to be in docs longer than necessary.
  3. 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: bun run prettier --write <file-path>
  • This ensures consistent formatting across all documentation
Common patterns

Instructions:

markdown
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:

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 ThisNot This
people, companiesusers
summarizeaggregate
take a look atreference
can't, don'tcannot, do not
Filter button`Filter` button
Check out the docsClick here

© tmcfarlane, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/docs-write of tmcfarlane/oh-my-cursor.

Open the folder on GitHubat commit 5bad458

Used in 3 other repositories

We found 18 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 3 other GitHub owners. This page covers the copy in tmcfarlane/oh-my-cursor, which our catalogue first saw on October 7, 2026.

Compare with similar skills

Docs Write next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs Write compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Write this skilltmcfarlane/oh-my-cursor1103 repos~716Automated safety check: NotesMIT
Markdown Article FormatterJimLiu/baoyu-skills26k7 repos~3.5kAutomated safety check: PassMIT
MarkitdownImCa0/just-laws78114 repos~3.2kAutomated safety check: NotesMIT
Obsidian MarkdownAtmosphere/atmosphere3.8k20 repos~1.3kAutomated safety check: PassApache-2.0
Gzh Designisjiamu/gzh-design-skill3.9k1 repos~2.2kAutomated safety check: PassAGPL-3.0
Crosspostingwasp-lang/wasp19k—~1.1kAutomated safety check: PassMIT

Similar skills

  • Markdown Article Formatter

    JimLiu/baoyu-skills

    Reformats plain text or Markdown articles with frontmatter, a title, a summary, headings, bold, lists and code blocks, and saves a separate formatted copy.

    26k GitHub starsUsed in 7 repos~3.5k tokens
    Documents & OfficeAuto-check passed
  • Markitdown

    ImCa0/just-laws

    Convert files and office documents to Markdown. An agent skill from ImCa0/just-laws.

    781 GitHub starsUsed in 14 repos~3.2k tokens
    Documents & OfficeAuto-check: notes
  • Obsidian Markdown

    Atmosphere/atmosphere

    Create and edit Obsidian Flavored Markdown with wikilinks, embeds, callouts, properties, and other Obsidian-specific syntax.

    3.8k GitHub starsUsed in 20 repos~1.3k tokens
    Documents & OfficeAuto-check passed
  • Gzh Design

    isjiamu/gzh-design-skill

    微信公众号文章排版引擎,将 Markdown 转换为可直接粘贴到公众号编辑器的 HTML。主题风格从 references/theme-index.md 注册的自定义主题库中选取,自动章节编号、关键词下划线标记、引言卡片、目录导航、代码块、图片/GIF、作者签名。支持 Markdown / Word(.docx) / PDF / 纯文本输入(非 Markdown…

    3.9k GitHub starsUsed in 1 repo~2.2k tokens
    Documents & OfficeAuto-check passed
  • Crossposting

    wasp-lang/wasp

    Crosspost Wasp blog articles (MDX) to DEV.to and Medium. An agent skill from wasp-lang/wasp.

    19k GitHub stars~1.1k tokensUpdated yesterday
    Documents & OfficeAuto-check passed
  • Review The Docs

    supabase/supabase

    Official

    Review Supabase docs changes locally in your supabase/supabase checkout — either an open PR (triage, classify, verify) or your own branch before opening a PR (local self-review).

    111k GitHub stars~4.6k tokensUpdated today
    Documents & OfficeAuto-check passed

More from tmcfarlane/oh-my-cursor

All 14 skills in this repo
  • Debugging

    tmcfarlane/oh-my-cursor

    Systematic 4-phase debugging with root cause investigation. An agent skill from tmcfarlane/oh-my-cursor.

    110 GitHub stars~4.4k tokensUpdated 3 mo ago
    Auto-check passed
  • Documentation Engineer

    tmcfarlane/oh-my-cursor

    Technical documentation expert for creating clear, comprehensive documentation.

    110 GitHub stars~881 tokensUpdated 3 mo ago
    Auto-check passed
  • Planning

    tmcfarlane/oh-my-cursor

    Technical implementation planning and architecture design. An agent skill from tmcfarlane/oh-my-cursor.

    110 GitHub stars~815 tokensUpdated 3 mo ago
    Auto-check passed
  • Codebase Search

    tmcfarlane/oh-my-cursor

    Search and navigate large codebases efficiently. An agent skill from tmcfarlane/oh-my-cursor.

    110 GitHub starsUsed in 1 repo~2.8k tokens
    Auto-check: notes
  • Cursor Image Generation

    tmcfarlane/oh-my-cursor

    Generate and iterate images in Cursor using the built-in image model and strong prompts.

    110 GitHub stars~1.8k tokensUpdated 3 mo ago
    Auto-check passed
  • Design Patterns Implementation

    tmcfarlane/oh-my-cursor

    Apply appropriate design patterns (Singleton, Factory, Observer, Strategy, etc.) to solve architectural problems.

    110 GitHub stars~2.2k tokensUpdated 3 mo ago
    Auto-check passed

Questions about Docs Write

What does Docs Write do?

Write documentation following Metabase's conversational, clear, and user-focused style. Docs Write is an agent skill from tmcfarlane/oh-my-cursor. Write documentation following Metabase's conversational, clear, and user-focused style.

When should I use Docs Write?

Docs Write fits situations like: editing documentation files (markdown; tasks that involve Markdown.

How do I install Docs Write in Claude Code?

Run `npx skills add tmcfarlane/oh-my-cursor --skill docs-write -a claude-code`. Or copy the skill folder (skills/docs-write in tmcfarlane/oh-my-cursor) into .claude/skills/docs-write in your project. Claude Code loads it when a task matches its description.

How do I install Docs Write in Codex?

Run `npx skills add tmcfarlane/oh-my-cursor --skill docs-write -a codex`. Or copy the skill folder (skills/docs-write in tmcfarlane/oh-my-cursor) into .agents/skills/docs-write in your project. Codex loads it when a task matches its description.

Can I use Docs Write in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add tmcfarlane/oh-my-cursor --skill docs-write -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-write, .gemini/skills/docs-write, .github/skills/docs-write and .opencode/skills/docs-write in your project.

What does Docs Write need to run?

Going by SKILL.md and its folder, Docs Write needs the command-line tools its instructions call (bun). Its frontmatter pre-approves these tools: Read, Write, Grep, Bash, Glob.

Does Docs Write access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Docs Write safe to install?

Our automated static check of SKILL.md found notes only (pre-approves every shell command (allowed-tools: bash)), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does Docs Write use?

Docs Write is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs Write use?

About 716 tokens (SKILL.md is roughly 2.9k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Docs Write?

Skills that share tags, products or a category with Docs Write: Markdown Article Formatter (JimLiu/baoyu-skills, 26k stars), Markitdown (ImCa0/just-laws, 781 stars), Obsidian Markdown (Atmosphere/atmosphere, 3.8k stars) and Gzh Design (isjiamu/gzh-design-skill, 3.9k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Write?

tmcfarlane (a GitHub user) maintains it in tmcfarlane/oh-my-cursor, which has 110 GitHub stars. The repository holds 14 skills in this directory. The repository was last updated on July 2, 2026.

Source: tmcfarlane/oh-my-cursor on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.