New: 98,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 Writer

by agulli in agulli/atlas-agents

Write or update technical documentation for code, APIs, or systems.

MITAuto-check passedDevelopment

Install Documentation Writer

skills CLI
$ npx skills add agulli/atlas-agents --skill documentation-writer -a claude-code

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

GitHub CLI
$ gh skill install agulli/atlas-agents documentation-writer --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/agulli/atlas-agents.git skills-src && mkdir -p .claude/skills && cp -r skills-src/ch09_agent_skills/skills/documentation-writer .claude/skills/documentation-writer && 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-writer
GitHub stars
579
Token cost
~639 tokens
SKILL.md length
279 words
Files
1
Skills in repo
12
Repo updated
First seen
Licence
MIT

At a glance

Write or update technical documentation for code, APIs, or systems.

  • Works in 6 steps: Read the source first. Load the actual… → Identify the documentation type → For READMEs, follow this structure → …
  • Asked to document a module
  • SKILL.md covers Overview, Process, Rationalizations and Verification
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Documentation Writer is an agent skill from agulli/atlas-agents. Write or update technical documentation for code, APIs, or systems. Use when asked to document a module, write a README, generate API docs, or update existing documentation.

Its SKILL.md is about 640 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 Development, covering Technical documentation. The licence is MIT.

When your agent uses it

  • Asked to document a module
  • Generate API docs
  • Update existing documentation

Example prompts

  • “/documentation-writer”

Workflow steps

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

  1. Read the source first. Load the actual code before writing a single word. Documentation that doesn't match the implementation is worse…
  2. Identify the documentation type
  3. For READMEs, follow this structure
  4. For function/class docs, write docstrings that include
  5. Write the example first. If you cannot write a concrete 5-line example of how to use something, you don't understand it well enough to…
  6. Verify accuracy. Read your documentation and check every claim against the code. If you wrote "returns a list of strings" and the code…

What it can do on your machine

Read from SKILL.md and the folder at commit 2b21998. 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

    No scripts in the folder and no shell commands in SKILL.md.

    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 Writer loads about 639 tokens when it runs. Until then it costs about 49 tokens; SKILL.md has 279 words of instructions outside code blocks.

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

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 agulli/atlas-agents at commit 2b21998, republished under its MIT licence (© agulli). 279 words, ~639 tokens.

Download SKILL.mdSave it as .claude/skills/documentation-writer/SKILL.md (or your agent's skills folder).
name
documentation-writer
description
Write or update technical documentation for code, APIs, or systems. Use when asked to document a module, write a README, generate API docs, or update existing documentation.
license
MIT

Overview

You write documentation that developers will actually read. That means concrete examples over abstract descriptions, and answering the question "how do I use this?" before "what is this?".

Process

  1. Read the source first. Load the actual code before writing a single word. Documentation that doesn't match the implementation is worse than no documentation.

  2. Identify the documentation type:

    • README — for projects and repositories
    • Module/API docs — for functions, classes, endpoints
    • Architecture docs — for system design and component relationships
    • Runbook — for operational procedures

  3. For READMEs, follow this structure:

    # Project Name
One sentence: what it does and who it's for.

## Quick Start
The fewest possible steps to get something working.
Code first. Explanation second.

## Installation
## Usage
## Configuration
## API Reference (if applicable)
## Contributing
## License

  4. For function/class docs, write docstrings that include:

    • What the function does (one line)
    • Parameters: name, type, description, whether optional
    • Return value: type and description
    • Exceptions it may raise
    • One usage example

  5. Write the example first. If you cannot write a concrete 5-line example of how to use something, you don't understand it well enough to document it. Go back to step 1.

  6. Verify accuracy. Read your documentation and check every claim against the code. If you wrote "returns a list of strings" and the code returns a dict, fix it.

Rationalizations

ExcuseRebuttal
"The code is self-documenting"No code is self-documenting to someone seeing it for the first time. Write the docs.
"I'll add examples later"Documentation without examples is theory. Write the example now.
"The function signature explains it"Type hints say what the types are, not what the function does or why.

Verification

  • Every documented function has at least one usage example
  • Parameter types and return types are correct (verified against the source)
  • Quick Start section in README can be followed by a new developer with no prior context
  • No documentation contradicts the actual implementation

© agulli, 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 ch09_agent_skills/skills/documentation-writer of agulli/atlas-agents.

Open the folder on GitHubat commit 2b21998

Compare with similar skills

Documentation Writer 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 Writer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Documentation Writer this skillagulli/atlas-agents579—~639Automated safety check: PassMIT
Diagram Designcathrynlavery/diagram-design45k1 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.5kAutomated 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.

    45k 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.5k tokensUpdated today
    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 6 days ago
    DevelopmentAuto-check: notes

More from agulli/atlas-agents

All 12 skills in this repo

  • API Design

    agulli/atlas-agents

    Design or review REST and GraphQL API interfaces. An agent skill from agulli/atlas-agents.

    579 GitHub stars~539 tokensUpdated 2 mo ago
    Auto-check passed

  • Data Pipeline

    agulli/atlas-agents

    Design, build, or debug data processing pipelines. An agent skill from agulli/atlas-agents.

    579 GitHub stars~714 tokensUpdated 2 mo ago
    Auto-check passed

  • Database Migration

    agulli/atlas-agents

    Safely run database schema migrations. An agent skill from agulli/atlas-agents.

    579 GitHub stars~702 tokensUpdated 2 mo ago
    Auto-check passed

  • Deploy Checklist

    agulli/atlas-agents

    Execute a structured deployment to staging or production. An agent skill from agulli/atlas-agents.

    579 GitHub stars~756 tokensUpdated 2 mo ago
    Auto-check passed

  • Git Commit

    agulli/atlas-agents

    Create well-structured git commits with conventional commit messages.

    579 GitHub stars~463 tokensUpdated 2 mo ago
    Auto-check: notes

  • Performance Profiling

    agulli/atlas-agents

    Profile and optimize application performance. An agent skill from agulli/atlas-agents.

    579 GitHub stars~804 tokensUpdated 2 mo ago
    Auto-check passed

Categories

Questions about Documentation Writer

What does Documentation Writer do?

Write or update technical documentation for code, APIs, or systems. Documentation Writer is an agent skill from agulli/atlas-agents. Write or update technical documentation for code, APIs, or systems.

When should I use Documentation Writer?

Documentation Writer fits situations like: asked to document a module; generate API docs; update existing documentation.

How do I install Documentation Writer in Claude Code?

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

How do I install Documentation Writer in Codex?

Run `npx skills add agulli/atlas-agents --skill documentation-writer -a codex`. Or copy the skill folder (ch09_agent_skills/skills/documentation-writer in agulli/atlas-agents) into .agents/skills/documentation-writer in your project. Codex loads it when a task matches its description.

Can I use Documentation Writer 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 agulli/atlas-agents --skill documentation-writer -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-writer, .gemini/skills/documentation-writer, .github/skills/documentation-writer and .opencode/skills/documentation-writer in your project.

What does Documentation Writer need to run?

SKILL.md names no scripts, command-line tools or credentials: Documentation Writer is instructions for the agent only.

Does Documentation Writer 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 Writer 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 Writer use?

Documentation Writer is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Documentation Writer use?

About 639 tokens (SKILL.md is roughly 2.6k 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 Documentation Writer?

Skills that share tags, products or a category with Documentation Writer: Diagram Design (cathrynlavery/diagram-design, 45k 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 Writer?

agulli (a GitHub user) maintains it in agulli/atlas-agents, which has 579 GitHub stars. The repository holds 12 skills in this directory. The repository was last updated on July 17, 2026.

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