documentation-engineer

documentation-engineer is a skill for Claude Code from tmcfarlane/oh-my-cursor. It costs 29 tokens per session (787 once invoked), scanned A, original, MIT.

A technical-writing guide for producing clear and maintainable software documentation. It covers README files, API documentation, and comments that explain why code exists.

In plain words
What is it for?
Use it when writing a README, documenting an API or function, adding code comments, or creating other developer-facing documentation.
Why use it?
It gives developers a consistent structure for installation steps, usage, configuration, development, errors, and examples. This makes project information easier to use and update.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter.

Needs its repository: it runs a file that does not travel with it, so clone the repository first. The line is python scripts/generate_docs.py.

Good fit Use it when writing a README, documenting an API or function, adding code comments, or creating other developer-facing documentation.

Compare 6 skills from other repositories ↓
Install

Getting it into your agent

It runs from inside its repository, so the clone comes first — what it calls does not travel with the file alone.

Clone the repo
git clone --depth 1 https://github.com/tmcfarlane/oh-my-cursor
agentmods
npx agentmods add skills/tmcfarlane/oh-my-cursor/documentation-engineer

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for documentation-engineer

README.md
[![agentmods](https://agentmods.dev/badge/skills/tmcfarlane/oh-my-cursor/documentation-engineer/github.svg)](https://agentmods.dev/skills/tmcfarlane/oh-my-cursor/documentation-engineer)
Your own site
<a href="https://agentmods.dev/skills/tmcfarlane/oh-my-cursor/documentation-engineer"><img src="https://agentmods.dev/badge/skills/tmcfarlane/oh-my-cursor/documentation-engineer/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for documentation-engineer

Your own site · 80×15
<a href="https://agentmods.dev/skills/tmcfarlane/oh-my-cursor/documentation-engineer"><img src="https://agentmods.dev/badge/skills/tmcfarlane/oh-my-cursor/documentation-engineer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 29 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 787 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe. Third-party audits
  • NVIDIA SkillSpector warn 7 Sept 2026
SkillSpector: 1 finding, up to medium

These are SkillSpector’s own severities. On a checked sample its high-severity flags on skills were ~96% false positives — a documented command, a public API, a “never do X” rule — so we show them as a caution to read, not a verdict. Why →

  • medium Excessive Agency · line 88
    Skill enables autonomous high-impact decisions without human-in-the-loop verification. Critical operations (destructive commands, financial transactions, data deletion) should require explicit user confirmation.
    Fix: Add human-in-the-loop confirmation for destructive, irreversible, or high-impact operations. Never auto-execute commands that modify files, send data, or alter system state.
How audits are shown
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00029 $0.00787
Opus 5.5 $0.00012 $0.00315
Sonnet 5.5 $0.00006 $0.00157
Haiku 4.5 $0.00003 $0.00079

Measured 1mo ago against content hash 93d8b0132e10, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

documentation-engineer scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

skills/documentation-engineer/SKILL.md · 171 lines

How it starts

The opening of the file, as written. The whole thing — 171 lines — stays where its author put it; the contents beside it link to each section on GitHub.

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:

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

// 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

Read the full file on GitHub · 171 lines

Files

What ships with it

3 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 1mo ago First seen · 171 lines · 29 tokens per session scan A 93d8b0132e10

Subscribe to this mod's changes

documentation-engineer is a skill published in the GitHub repository tmcfarlane/oh-my-cursor (109 stars, last pushed 3mo ago), licensed MIT. It adds 29 tokens to every session and 787 once invoked, about $0.0001 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

chronicle

Analyze Copilot session history for standup reports, usage tips, session search, and session reindexing. Use when the user asks for a standup, daily summary, usage tips, workflow recommendations, wants to search or find past sessions by keyword/file/PR, wants to reindex their session store, or asks about deleting…

microsoft/vscode · 72 tokens

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

component-fixtures

Use when creating or updating component fixtures for screenshot testing or their shared infrastructure, or when designing UI components to be fixture-friendly. Covers fixture file structure, theming, service setup, CSS scoping, async rendering, validation, and common pitfalls.

microsoft/vscode · 53 tokens