gem-documentation-writer

gem-documentation-writer is an agent for Claude Code from github/awesome-copilot. It costs 20 tokens per session (645 once invoked), scanned A, original, MIT.

A technical writing agent for creating and updating documentation, such as README files, API references, diagrams, walkthroughs, and AGENTS.md files. It checks that the documentation matches the source code.

In plain words
What is it for?
Use it to write or update developer documentation, product requirements, repository guidance, and diagrams.
Why use it?
It removes the effort of structuring technical documents and checking them against the implementation. It also helps keep documentation concise and free of missing or speculative details.

Agent for Claude Code ✓ vendor

Written for Claude Code: disable-model-invocation in frontmatter. Also seen: mentions subagents; mentions AGENTS.md.

Good fit Use it to write or update developer documentation, product requirements, repository guidance, and diagrams.

Compare 6 agents from other repositories ↓
Install with agentmods
npx agentmods add agents/github/awesome-copilot/gem-documentation-writer
About the project

Awesome GitHub Copilot is a community collection of custom agents, instructions, skills, hooks, workflows, plugins, and configuration for GitHub Copilot. It helps Copilot users customize coding and development tasks. Catalogue entries are individual Copilot add-ons from this collection.

github/awesome-copilot · 40,517 stars · on GitHub

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Clone the repo
git clone --depth 1 https://github.com/github/awesome-copilot

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 gem-documentation-writer

README.md
[![agentmods](https://agentmods.dev/badge/agents/github/awesome-copilot/gem-documentation-writer/github.svg)](https://agentmods.dev/agents/github/awesome-copilot/gem-documentation-writer)
Your own site
<a href="https://agentmods.dev/agents/github/awesome-copilot/gem-documentation-writer"><img src="https://agentmods.dev/badge/agents/github/awesome-copilot/gem-documentation-writer/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 gem-documentation-writer

Your own site · 80×15
<a href="https://agentmods.dev/agents/github/awesome-copilot/gem-documentation-writer"><img src="https://agentmods.dev/badge/agents/github/awesome-copilot/gem-documentation-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 20 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 645 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.
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.00020 $0.00645
Opus 5.5 $0.00008 $0.00258
Sonnet 5.5 $0.00004 $0.00129
Haiku 4.5 $0.00002 $0.00064

Measured 15d ago against content hash bca0182b0c3c, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

gem-documentation-writer 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 15d 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:

agents/gem-documentation-writer.agent.md · 66 lines

What it actually says

DOCUMENTATION WRITER

Write docs, READMEs, API docs, diagrams. Maintain AGENTS.md. Never implement code.

<output_format>

{
  "status": "completed | failed | needs_retry | blocked",
  "reason": "string",
  "fail": "fixable | needs_replan | escalate | flaky | regression | new_failure | platform_specific",
  "created": 0,
  "updated": 0,
  "handoff": {
    "created_paths": ["string"],
    "updated_paths": ["string"],
    "verdict": "pass | fail"
  },
  "learn": "string"
}

</output_format>

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. 15d ago Changed · +5 lines bca0182b0c3c
  2. 1mo ago Changed · -17 lines d911fad1acc4
  3. 1mo ago Changed · +10 lines 7c630a881e85
  4. 1mo ago First seen · 68 lines · 20 tokens per session scan A 52ae6f6e3e0e

Subscribe to this mod's changes

gem-documentation-writer is an agent published in the GitHub repository github/awesome-copilot (40,517 stars, last pushed today), licensed MIT. It adds 20 tokens to every session and 645 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-09-03.

Related

Other agents, from other repositories

software-engineer

SWE role definition for /implement-universal. Loaded by the orchestrator at the start of the SWE phase. Implements one workshop ticket from implementyourself/tasks/NNN-slug.groomed.md, populates the skeleton under implementyourself/src/, runs make QA + the ticket's e2e target, and produces a hand-off message in the…

Arindam200/awesome-ai-apps · 98 tokens

tech-writer

Writes and reviews docs and instruction files (SKILL.md, CLAUDE.md, agent defs); returns findings, edits, a draft diff, or a digest. - Use when docs lag code, such a file's diff needs review, instructions need drafting, a decided spec must land in a design doc, or files need digesting unread. Edits only docs; review…

uwuclxdy/agenticat · 91 tokens

ndv-signal

Metrics skeptic. Use when reviewing engineering KPIs, OKRs, sprint velocity, test coverage targets, DORA metrics, or any measurement system. Audits whether metrics measure what they claim to measure. Goodhart's Law as a cognitive style — the moment a measure becomes a target, it stops being a measure, and Signal…

emb715/neurodiveragents · 76 tokens

ndv-explain

Technical documentation writer. Use when creating or updating docs, API references, session notes, or any written material explaining code to humans. Never assumes shared context — models the reader's knowledge gap and bridges it deliberately.

emb715/neurodiveragents · 47 tokens

explorer-agent

Advanced codebase discovery, deep architectural analysis, and proactive research agent. The eyes and ears of the framework. Use for initial audits, refactoring plans, and deep investigative tasks.

ashrafmusa/agenticana · 40 tokens

playwright-test-generator

Use this agent when you need to create automated browser tests using Playwright Examples: Context: User wants to generate a test for the test plan item.

microsoft/playwright · 151 tokens