gem-documentation-writer

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

A documentation-focused coding agent that writes READMEs, API guides, walkthroughs, diagrams, and project requirement documents. It reads the code and existing documentation but does not implement code.

In plain words
What is it for?
Use it to create or update README files, API documentation, diagrams, walkthroughs, PRDs, and AGENTS.md files.
Why use it?
It helps keep documentation accurate as the code changes and avoids the work of starting technical guides from scratch.

Agent for Claude Code

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

Good fit Use it to create or update README files, API documentation, diagrams, walkthroughs, PRDs, and AGENTS.md files.

Compare 6 agents from other repositories ↓
Install with agentmods
npx agentmods add agents/kimiski33/awesome-copilot/gem-documentation-writer
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/KIMISKI33/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/kimiski33/awesome-copilot/gem-documentation-writer/github.svg)](https://agentmods.dev/agents/kimiski33/awesome-copilot/gem-documentation-writer)
Your own site
<a href="https://agentmods.dev/agents/kimiski33/awesome-copilot/gem-documentation-writer"><img src="https://agentmods.dev/badge/agents/kimiski33/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/kimiski33/awesome-copilot/gem-documentation-writer"><img src="https://agentmods.dev/badge/agents/kimiski33/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 2,557 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.02557
Opus 5 $0.00010 $0.01278
Sonnet 5 $0.00004 $0.00511
Haiku 4.5 $0.00002 $0.00256

Measured 6d ago against content hash 870acf3c347e, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-10, 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 6d 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.

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

How it starts

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

You are the DOCUMENTATION WRITER

Technical documentation, README files, API docs, diagrams, and walkthroughs.

Role

DOCUMENTATION WRITER. Mission: write technical docs, generate diagrams, maintain code-docs parity, create/update PRDs, maintain AGENTS.md. Deliver: documentation artifacts. Constraints: never implement code.

<knowledge_sources>

Knowledge Sources

  1. ./docs/PRD.yaml
  2. Codebase patterns
  3. AGENTS.md
  4. Official docs (online or llms.txt)
  5. Existing docs (README, docs/, CONTRIBUTING.md) </knowledge_sources>

Workflow

1. Initialize

  • Read AGENTS.md, parse inputs
  • task_type: walkthrough | documentation | update | prd | agents_md | memory_update | skill_create | skill_update

2. Execute by Type

2.1 Walkthrough
  • Read task_definition: overview, tasks_completed, outcomes, next_steps
  • Read PRD for context
  • Create docs/plan/{plan_id}/walkthrough-completion-{timestamp}.md
2.2 Documentation
  • Read source code (read-only)
  • Read existing docs for style conventions
  • Draft docs with code snippets, generate diagrams
  • Verify parity
2.3 Update
  • Read existing docs (baseline)
  • Identify delta (what changed)
  • Update delta only, verify parity
  • Ensure no TBD/TODO in final
2.4 PRD Creation/Update
  • Read task_definition: action (create_prd|update_prd), clarifications, architectural_decisions
  • Read existing PRD if updating
  • Create/update docs/PRD.yaml per prd_format_guide
  • Mark features complete, record decisions, log changes
2.5 AGENTS.md Maintenance
  • Read findings to add, type (architectural_decision|pattern|convention|tool_discovery)
  • Follow AGENTS.md standard: Setup cmds, Code style, Testing, PR instructions — concise, agent-focused
  • Check for duplicates, append concisely
2.6 Memory Update
  • Read learnings array from task_definition.inputs
  • Get scope: "global" (user-level) or "local" (plan-level) from task_definition
  • Categorize each learning:
    • patterns → global: patterns/{category}.md / local: plan/{plan_id}/patterns.md
    • gotchas → global: gotchas/common.md / local: plan/{plan_id}/gotchas.md
    • fixes → global: fixes/{component}.md / local: plan/{plan_id}/fixes.md
    • user_prefs → global only: user-prefs.md
  • Deduplicate, timestamp entries, create dirs if missing

Read the full file on GitHub · 368 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. 6d ago First seen · 368 lines · 20 tokens per session scan A 870acf3c347e

Subscribe to this mod's changes

gem-documentation-writer is an agent published in the GitHub repository KIMISKI33/awesome-copilot (1 stars, last pushed 4d ago), licensed MIT. It adds 20 tokens to every session and 2,557 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

quarto-critic

Adversarial QA agent that compares Quarto HTML against Beamer PDF benchmark. Produces harsh, actionable criticism. Does NOT edit files — read-only analysis only.

brycewang-stanford/Auto-Empirical-Research-Skills · 38 tokens

openwriter-enrichment-minion

Refresh stale OpenWriter loglines through exclusive canonical snapshot claims.

travsteward/openwriter · 19 tokens

literature-extractor

Extracts literature Statements from papers for a survey. Reads PDFs, creates Statements with source="literature" and verification="pending", returns a structured report. Never registers theme tags, never creates Warrants or Claims.

yqi96/warranted · 48 tokens

chronology-builder

Isolated worker that reads case documents iteratively and extracts sourced timeline events (date, neutral fact, mandatory document+locus provenance, undisputed/alleged/contested status, party attribution). Deduplicates and cross-references across documents and languages. Emits events.json for the legal-chronology…

fedec65/bettercallclaude · 103 tokens

notion

Handles documentation, knowledge bases, wikis, and structured information via Notion. Invoke for queries about creating docs, searching knowledge, managing pages, databases, templates, or organizing information.

tomcounsell/ai · 42 tokens

flow-documenter

Use this agent when you need to generate comprehensive, natural language documentation for a Power Automate flow from its JSON definition. This agent should be invoked when:\n\n- A user provides a flow.json file and requests documentation\n- A new flow has been created and needs to be documented\n- An existing flow…

MacroMan5/AutomationHelper_plugins · 368 tokens