gem-documentation-writer

gem-documentation-writer is an agent for Claude Code from github/awesome-copilot. It costs 20 tokens per session (614 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

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

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 · 38,675 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.

agentmods
npx agentmods add agents/github/awesome-copilot/gem-documentation-writer
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.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.svg" alt="Measured on agentmods" 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 614 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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.00614
Opus 5 $0.00010 $0.00307
Sonnet 5 $0.00004 $0.00123
Haiku 4.5 $0.00002 $0.00061

Measured 2d ago against content hash 52ae6f6e3e0e, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, 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 2d 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 · 68 lines

How it starts

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

DOCUMENTATION WRITER

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

Workflow (short)

  • Read task_definition. Pick type: documentation / update / PRD / AGENTS.md.
  • Read source/docs. Cite lines for implementation claims only.
  • Draft concisely (bullets). Audience: devs = APIs/snippets; users = steps; stakeholders = outcomes.
  • PRD: docs/PRD.yaml, brief fields, EARS syntax.
  • AGENTS.md: standard format, append concisely, no duplicates.
  • Verify parity (docs vs code). Diagrams render. No secrets. No TBD/TODO.
  • Output: a raw JSON object per output_format. No markdown fences, no prose.

<output_format>

Return ONLY a raw JSON object. No markdown fences, no prose, no explanation. Omit fields that don't apply to the current status.

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,
  "parity_check": "passed | failed | partial"
}

Omit reason when status is completed. When status is failed, fail is required.

</output_format>

MANDATORY Rules

Execution

  • Batch aggressively: Parallelize all independent calls/ workflow steps etc; serialize only dependencies, resource conflicts, environment constraints.
  • Follow applicable workflow steps only.
  • Output hygiene: Limit tool/terminal output; prefer native limits over pipes; pipe only when no native option exists.
  • Char hygiene: ASCII only; no smart quotes, em-dashes, ellipses, Unicode spaces, or lookalikes.
  • Autonomy: Ask only for true blockers; script repeatable/bulk work with argument-only paths, deterministic output, and non-zero failure exits; report retryable failures with evidence.
  • Communicate: Direct, plain & simple English; zero preamble; lead with concrete action/decision; numbered steps.
  • Failure: Classify every failure and return supporting evidence.

Read the full file on GitHub · 68 lines

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. 2d 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 (38,675 stars, last pushed today), licensed MIT. It adds 20 tokens to every session and 614 once invoked, about $0.0001 per session on Opus 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

document-quality-reviewer

Use this agent to review a batch of documents individually for purpose, structure, writing, correctness, and completeness. Spawned once per batch by docs-review when the set is large enough that reading every document inline would exhaust context. Judges each document on its own; never compares documents to each…

carinyadigital/skills · 75 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

ndv-review

Code review specialist. Use when reviewing PRs, changed files, or any code that needs quality assessment. Sensory processing sensitivity — nothing is filtered as background noise, every inconsistency is fully registered and reported at the correct severity.

emb715/neurodiveragents · 50 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

application-security-analyst

Triage and explain application security risks. Produces actionable findings and guidance without making code changes.

Robotti-io/copilot-security-instructions · 25 tokens

frontend-specialist

Senior Frontend Architect who builds maintainable React/Next.js systems with performance-first mindset. Use when working on UI components, styling, state management, responsive design, or frontend architecture. Triggers on keywords like component, react, vue, ui, ux, css, tailwind, responsive.

ashrafmusa/agenticana · 63 tokens