Agent skill

Maintaining Documentation

by obra in obra/dotfiles

A skill your agent uses when documentation needs creating, checking, or maintaining — docs may have drifted from code, pre-release doc verification, updating docs after finishing code work, adding…

No licenceAuto-check passedWriting & Content

Install Maintaining Documentation

skills CLI
$ npx skills add obra/dotfiles --skill maintaining-documentation -a claude-code

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

GitHub CLI
$ gh skill install obra/dotfiles maintaining-documentation --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/obra/dotfiles.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/maintaining-documentation .claude/skills/maintaining-documentation && 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
maintaining-documentation
GitHub stars
116
Token cost
~3.9k tokens
SKILL.md length
2,185 words
Files
10 (incl. scripts, references)
Skills in repo
12
Repo updated
First seen
Licence
None found

At a glance

A skill your agent uses when documentation needs creating, checking, or maintaining — docs may have drifted from code, pre-release doc verification, updating docs after finishing code work, adding…

  • Works in 5 steps: the doc is evergreen; → the claim is mechanical — an… → a single live (non-test) counterpart… → …
  • Documentation needs creating
  • SKILL.md covers Overview, Dispatch — read the flow file…, STOP: classify before you edit… and Scope & exclusions, plus 8 more sections
  • Runs Python scripts from its folder; calls git

What it does

Maintaining Documentation is an agent skill from obra/dotfiles. Use when documentation needs creating, checking, or maintaining — docs may have drifted from code, pre-release doc verification, updating docs after finishing code work, adding or enforcing project terminology, deciding where a new doc should live, or a routine re-audit of previously verified docs.

Its SKILL.md is about 3.9k tokens, which your agent loads only when the skill is triggered. The skill folder holds 12 other files, including scripts and reference files (for example `references/audit.md`, `references/dictionary.md` and `references/incremental.md`).

It sits in Writing & Content, covering Technical writing.

When your agent uses it

  • Documentation needs creating
  • Maintaining — docs may have drifted from code
  • Pre-release doc verification
  • Updating docs after finishing code work

Example prompts

  • “/maintaining-documentation”

Requirements

  • Python 3

Workflow steps

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

  1. the doc is evergreen;
  2. the claim is mechanical — an identifier/path, CLI flag, config/env
  3. a single live (non-test) counterpart exists in the code, so the right
  4. it's a local token replacement that leaves the surrounding sentence
  5. a missing counterpart is confirmed removed vs. renamed via git history

What it can do on your machine

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

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships 2 files in scripts/ (Python), which the agent can run.

    Shell commands in SKILL.md call:

    • git

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

  • Network

    No URLs in SKILL.md. Its commands use git, which can reach the network depending on how they are called.

    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

Maintaining Documentation loads about 3.9k tokens when it runs, and up to ~7.3k if it reads all its reference files. Until then it costs about 81 tokens; SKILL.md has 2,185 words of instructions outside code blocks.

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

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); the scripts in this folder are not scanned.

SKILL.md

Without a licence we can't republish the file, so here is its outline and opening line. It has 2,185 words (~3,901 tokens).

“A doc is a set of claims about reality; this skill keeps a project's docs matching reality over time. The same law binds every flow: decide whether a doc is even supposed to track current reality (classify first), auto-fix only…”

— opening of SKILL.md by obra
name
maintaining-documentation

Read the full SKILL.md on GitHub

Files

SKILL.md and 9 other files (scripts, references) in .claude/skills/maintaining-documentation of obra/dotfiles.

  • SKILL.md
  • references/audit.md
  • references/dictionary.md
  • references/incremental.md
  • references/new-docs.md
  • references/write-path.md
  • scripts/docmaint
  • scripts/docmaint_test.py
  • templates/DICTIONARY-template.md
  • templates/INDEX-template.md

Open the folder on GitHubat commit df3be56

Compare with similar skills

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

Maintaining Documentation compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Maintaining Documentation this skillobra/dotfiles116—~3.9kAutomated safety check: PassNone
JavaScript Concept Fact Checkerleonardomso/33-js-concepts67k1 repos~5kAutomated safety check: PassMIT
Beads Documentation Style Guidegastownhall/beads28k—~3.2kAutomated safety check: PassMIT
JavaScript Concept Page Workflowleonardomso/33-js-concepts67k—~3.9kAutomated safety check: PassMIT
JS Concept Resource Curatorleonardomso/33-js-concepts67k—~4.9kAutomated safety check: PassMIT
Technical Writing Standardcursor/plugins10k10 repos~2.4kAutomated safety check: PassNone

Similar skills

  • JavaScript Concept Fact Checker

    leonardomso/33-js-concepts

    Verifies the technical accuracy of JavaScript concept pages by checking code examples, MDN and ECMAScript claims and external links through a five-phase method.

    67k GitHub starsUsed in 1 repo~5k tokens
    Writing & ContentAuto-check passed
  • Sets the house style for the beads user docs: the canonical concept model, required terminology, prose and diagram conventions, and checks before docs work is done.

    28k GitHub stars~3.2k tokensUpdated today
    Writing & ContentAuto-check passed
  • JavaScript Concept Page Workflow

    leonardomso/33-js-concepts

    Orchestrates five skills to produce a complete JavaScript concept documentation page, from resource curation through writing, tests, fact-checking and SEO.

    67k GitHub stars~3.9k tokensUpdated 27 days ago
    Writing & ContentAuto-check passed
  • JS Concept Resource Curator

    leonardomso/33-js-concepts

    Finds, vets, writes up and maintains external articles, videos and courses for JavaScript concept pages, including audits for broken and outdated links.

    67k GitHub stars~4.9k tokensUpdated 27 days ago
    Writing & ContentAuto-check passed
  • Official

    Applies four layers of technical-writing rules to docs, RFCs, readmes, PR descriptions and commit messages so a tired engineer follows them on the first read.

    10k GitHub starsUsed in 10 repos~2.4k tokens
    Writing & ContentAuto-check passed
  • Writing Docs

    nukeop/nuclear

    A skill your agent uses when writing or editing documentation in packages/docs.

    19k GitHub stars~907 tokensUpdated yesterday
    Writing & ContentAuto-check passed

More from obra/dotfiles

All 12 skills in this repo
  • Chronicle

    obra/dotfiles

    Allows you to view the user's screen as well as several hours of history.

    116 GitHub stars~1.4k tokensUpdated 1 mo ago
    Auto-check passed
  • A skill your agent uses when verifying a running application end-to-end through its real interface — a web UI, a CLI, or a TUI — by writing and executing agent-run "scenario cards" against a freshly…

    116 GitHub stars~1.8k tokensUpdated 1 mo ago
    Auto-check passed
  • Roborev Fix

    obra/dotfiles

    A skill your agent uses when the user asks to fix open failing reviews, invokes $roborev-fix, or provides job IDs; do not use when the user only pastes review findings with no request to discover or…

    116 GitHub stars~2.4k tokensUpdated 1 mo ago
    Auto-check passed
  • Syncing Obsidian

    obra/dotfiles

    A skill your agent uses when reading or writing files in an Obsidian vault that is synced with obsync.

    116 GitHub stars~1.7k tokensUpdated 1 mo ago
    Auto-check passed
  • MCP CLI

    obra/dotfiles

    Use MCP servers on-demand via the mcp CLI tool - discover tools, resources, and prompts without polluting context with pre-loaded MCP integrations

    116 GitHub starsUsed in 1 repo~2.3k tokens
    Auto-check passed
  • Request a design review for a commit and present the results

    116 GitHub stars~1.1k tokensUpdated 1 mo ago
    Auto-check passed

Questions about Maintaining Documentation

What does Maintaining Documentation do?

A skill your agent uses when documentation needs creating, checking, or maintaining — docs may have drifted from code, pre-release doc verification, updating docs after finishing code work, adding…. Maintaining Documentation is an agent skill from obra/dotfiles. Use when documentation needs creating, checking, or maintaining — docs may have drifted from code, pre-release doc verification, updating docs after finishing code work, adding or enforcing project terminology, deciding where a new doc should live, or a routine re-audit of previously verified docs.

When should I use Maintaining Documentation?

Maintaining Documentation fits situations like: documentation needs creating; maintaining — docs may have drifted from code; pre-release doc verification; updating docs after finishing code work.

How do I install Maintaining Documentation in Claude Code?

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

How do I install Maintaining Documentation in Codex?

Run `npx skills add obra/dotfiles --skill maintaining-documentation -a codex`. Or copy the skill folder (.claude/skills/maintaining-documentation in obra/dotfiles) into .agents/skills/maintaining-documentation in your project. Codex loads it when a task matches its description.

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

What does Maintaining Documentation need to run?

Going by SKILL.md and its folder, Maintaining Documentation needs Python for the scripts in its folder and the command-line tools its instructions call (git). Our summary lists: Python 3.

Does Maintaining Documentation access the network?

SKILL.md contains no URLs. Its commands use git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Maintaining Documentation 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. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does Maintaining Documentation use?

No licence was found for Maintaining Documentation or its repository. Without one, default copyright applies: ask the author before reusing or redistributing it.

How many tokens does Maintaining Documentation use?

About 3.9k tokens (SKILL.md is roughly 16k 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 3.4k tokens, read only when the agent opens those files.

What are the alternatives to Maintaining Documentation?

Skills that share tags, products or a category with Maintaining Documentation: JavaScript Concept Fact Checker (leonardomso/33-js-concepts, 67k stars), Beads Documentation Style Guide (gastownhall/beads, 28k stars), JavaScript Concept Page Workflow (leonardomso/33-js-concepts, 67k stars) and JS Concept Resource Curator (leonardomso/33-js-concepts, 67k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Maintaining Documentation?

obra (a GitHub user) maintains it in obra/dotfiles, which has 116 GitHub stars. The repository holds 12 skills in this directory. The repository was last updated on August 11, 2026.

Source: obra/dotfiles on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.