New: 97,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Documentation Engineer

by tmcfarlane in tmcfarlane/oh-my-cursor

Technical documentation expert for creating clear, comprehensive documentation.

MITAuto-check passedDevelopment

Install Documentation Engineer

skills CLI
$ npx skills add tmcfarlane/oh-my-cursor --skill documentation-engineer -a claude-code

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

GitHub CLI
$ gh skill install tmcfarlane/oh-my-cursor documentation-engineer --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/documentation-engineer .claude/skills/documentation-engineer && 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
documentation-engineer
GitHub stars
109
Token cost
~881 tokens
SKILL.md length
260 words
Files
4 (incl. references)
Skills in repo
14
Repo updated
First seen
Licence
MIT

At a glance

Technical documentation expert for creating clear, comprehensive documentation.

  • Works in 4 steps: README → API Documentation → Code Comments → …
  • User asks to write docs
  • SKILL.md covers When This Skill Activates, Documentation Types, Documentation Principles and Writing Guidelines, plus 3 more sections
  • Calls python

What it does

Documentation Engineer is an agent skill from tmcfarlane/oh-my-cursor. Technical documentation expert for creating clear, comprehensive documentation. Use when user asks to write docs, create README, or document code.

Its SKILL.md is about 880 tokens, which your agent loads only when the skill is triggered. The skill folder holds 4 other files, including reference files (for example `references/api-template.md`, `references/readme-template.md` and `references/style-guide.md`).

It sits in Development, covering Technical documentation. 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

  • User asks to write docs
  • Tasks that involve Technical documentation

Example prompts

  • “/documentation-engineer”

Requirements

  • Python 3
  • Pre-approved tools (allowed-tools): Read, Write, Edit, Grep, Glob, WebFetch, WebSearch

Workflow steps

4 steps, taken from the step headings in SKILL.md.

  1. README
  2. API Documentation
  3. Code Comments
  4. Architecture Documentation

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
    • Edit
    • Grep
    • Glob
    • WebFetch
    • WebSearch

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • python

    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

Documentation Engineer loads about 881 tokens when it runs, and up to ~1.1k if it reads all its reference files. Until then it costs about 42 tokens; SKILL.md has 260 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~42
When it runs · the whole SKILL.md, loaded when a task matches
~881
With references · SKILL.md plus every file in references/, read only if the agent opens them
~1.1k

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 passed

The automated check found no risky patterns in SKILL.md.

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). 260 words, ~881 tokens.

Download SKILL.mdSave it as .claude/skills/documentation-engineer/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.
name
documentation-engineer
description
Technical documentation expert for creating clear, comprehensive documentation. Use when user asks to write docs, create README, or document code.
allowed-tools
Read, Write, Edit, Grep, Glob, WebFetch, WebSearch

Documentation Engineer

Expert in creating clear, comprehensive, and maintainable technical documentation.

When This Skill Activates

Activates when you:

  • Ask to write documentation
  • Request README creation
  • Mention "docs" or "document this"
  • Need API documentation

Documentation Types

1. README

Every project should have a README with:

markdown
# Project Name

Brief description (what it does, why it exists)

## Quick Start

Installation and usage in 3 steps or less.

## Installation

Detailed installation instructions.

## Usage

Examples of common usage patterns.

## Configuration

Environment variables and configuration options.

## Development

How to run tests, build, and develop locally.

## Contributing

Guidelines for contributors.

## License

License information.
2. API Documentation

For each endpoint/function:

  • Description: What it does
  • Parameters: Name, type, required/optional, description
  • Return value: Type and structure
  • Errors: Possible errors and conditions
  • Examples: Usage examples
3. Code Comments

Comment why, not what:

typescript
// Bad: Sets the count to zero
count = 0;

// Good: Reset count for new measurement cycle
count = 0;

// Bad: Check if user is admin
if (user.role === 'admin') {

// Good: Only admins can bypass approval workflow
if (user.role === 'admin') {
4. Architecture Documentation
  • System overview
  • Component relationships
  • Data flow
  • Design decisions
  • Trade-offs considered

Documentation Principles

  1. Be Clear: Use simple, direct language
  2. Be Concise: Respect the reader's time
  3. Be Accurate: Keep docs in sync with code
  4. Be Complete: Cover all public interfaces
  5. Be Current: Update docs when code changes

Writing Guidelines

Headings
  • Use sentence case for headings
  • Start with a verb or noun
  • Be descriptive
Code Examples
  • Show before/after when appropriate
  • Include import statements
  • Show expected output
  • Handle edge cases
  • Use relative links for internal docs
  • Include anchors for sections
  • Test that links work
Diagrams
  • Use Mermaid for flowcharts and sequences
  • Keep diagrams simple
  • Add a title and legend

Documentation Checklist

README
  • Project description
  • Quick start guide
  • Installation instructions
  • Usage examples
  • Configuration guide
  • Contributing guidelines
Code Docs
  • All public functions documented
  • Parameters and returns documented
  • Examples provided for complex functions
  • Edge cases documented
API Docs
  • All endpoints documented
  • Request/response schemas
  • Authentication requirements
  • Error responses documented
  • Rate limits documented

Scripts

Generate documentation structure:

bash
python scripts/generate_docs.py

Validate documentation:

bash
python scripts/validate_docs.py

References

  • references/readme-template.md - README template
  • references/api-template.md - API documentation template
  • references/style-guide.md - Documentation style guide

© 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

SKILL.md and 3 other files (references) in skills/documentation-engineer of tmcfarlane/oh-my-cursor.

  • SKILL.md
  • references/api-template.md
  • references/readme-template.md
  • references/style-guide.md

Open the folder on GitHubat commit 5bad458

Compare with similar skills

Documentation Engineer 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.

Documentation Engineer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Documentation Engineer this skilltmcfarlane/oh-my-cursor109—~881Automated safety check: PassMIT
Diagram Designcathrynlavery/diagram-design44k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Get API Docs with chubandrewyng/context-hub14k2 repos~775Automated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.4kAutomated safety check: PassGPL-3.0

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    44k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed

  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed

  • Get API Docs with chub

    andrewyng/context-hub

    Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.

    14k GitHub starsUsed in 2 repos~775 tokens
    DevelopmentAuto-check passed

  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed

  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.4k tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 5 days ago
    DevelopmentAuto-check: notes

More from tmcfarlane/oh-my-cursor

All 14 skills in this repo

  • Docs Write

    tmcfarlane/oh-my-cursor

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

    109 GitHub starsUsed in 3 repos~716 tokens
    Auto-check: notes

  • Debugging

    tmcfarlane/oh-my-cursor

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

    109 GitHub stars~4.4k 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.

    109 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.

    109 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.

    109 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.

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

Categories

Questions about Documentation Engineer

What does Documentation Engineer do?

Technical documentation expert for creating clear, comprehensive documentation. Documentation Engineer is an agent skill from tmcfarlane/oh-my-cursor. Technical documentation expert for creating clear, comprehensive documentation.

When should I use Documentation Engineer?

Documentation Engineer fits situations like: user asks to write docs; tasks that involve Technical documentation.

How do I install Documentation Engineer in Claude Code?

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

How do I install Documentation Engineer in Codex?

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

Can I use Documentation Engineer 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 documentation-engineer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation-engineer, .gemini/skills/documentation-engineer, .github/skills/documentation-engineer and .opencode/skills/documentation-engineer in your project.

What does Documentation Engineer need to run?

Going by SKILL.md and its folder, Documentation Engineer needs the command-line tools its instructions call (python). Our summary lists: Python 3. Its frontmatter pre-approves these tools: Read, Write, Edit, Grep, Glob, WebFetch, WebSearch.

Does Documentation Engineer 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 Documentation Engineer safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Documentation Engineer use?

Documentation Engineer 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 Documentation Engineer use?

About 881 tokens (SKILL.md is roughly 3.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 254 tokens, read only when the agent opens those files.

What are the alternatives to Documentation Engineer?

Skills that share tags, products or a category with Documentation Engineer: Diagram Design (cathrynlavery/diagram-design, 44k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Documentation Engineer?

tmcfarlane (a GitHub user) maintains it in tmcfarlane/oh-my-cursor, which has 109 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.