Gem Documentation Writer
Technical documentation, README files, API docs, diagrams, walkthroughs.
- Type
- Subagent
- Repository
- github/awesome-copilot
- GitHub stars
- 39.4k
- License
- MIT
- Repo last updated
- Sep 27, 2026
- Source file
- agents/gem-documentation-writer.agent.md
What Gem Documentation Writer is
Gem Documentation Writer is a subagent published in the github/awesome-copilot repository on GitHub, which has about 39.4k stars. The repository describes itself as: “Community-contributed instructions, agents, skills, and configurations to help you make the most of GitHub Copilot.”
A subagent is a specialist assistant that Claude can hand part of a task to. It is a markdown file whose frontmatter sets a name, a description that tells Claude when to delegate, and optionally the tools and model it may use; the body becomes the subagent's own system prompt.
Because a subagent works in its own context, it keeps the main conversation focused: Claude can send a narrow job, such as a review or a specialised analysis, to Gem Documentation Writer and get back a compact result.
How to install Gem Documentation Writer
Claude Code
- Download gem-documentation-writer.agent.md from the repository.
- Save it to ~/.claude/agents/ to use it in every project, or to .claude/agents/ inside one project to share it through version control.
- Claude Code watches these folders, so the subagent is usually available right away. Ask Claude to use it by name, or @-mention it to make sure it runs.
Claude Cowork
- Cowork loads subagents through plugins. If the repository is packaged as a plugin marketplace, add it under Customize → Plugins → Add marketplace and install the plugin that contains this subagent.
- Otherwise, bundle the file into your own plugin's agents/ folder and upload it from Customize → Plugins.
New to extending Cowork? Our plugins guide and Customize guide explain how skills, plugins, and connectors fit together.
Inside the source file
An excerpt from agents/gem-documentation-writer.agent.md, shared under the repository's MIT license. Read the full file on GitHub.
Write docs, READMEs, API docs, diagrams. Maintain AGENTS.md. Never implement code.
Write docs, READMEs, API docs, diagrams. Maintain AGENTS.md. Never implement code.
- 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: raw JSON per output_format. No markdown, no prose.
{
"status": "completed | failed | needs_retry | blocked",
"reason": "string",
"fail": "fixable | needs_replan | escalate | flaky | regression | new_failure | platform_specific",
"created": 0,
"updated": 0,
"learn": "string"
}- Prefer native semantic tools for discovery/diagnostics; CLI for execution or when simpler.
- Batch independent calls/ steps; serialize dependencies/conflicts.
- Reuse established facts; inspect only for new unknowns, required work, or outcome verification.
- Ask only for true blockers; for repeatable/bulk work, prefer deterministic automation with non-zero failure exits; report retryable failures with evidence.
- Limit tool/terminal output; prefer native limits over pipes.
- No greetings, sign-offs, filler, or unnecessary prose.
- No unnecessary alternatives, caveats, repetition.
- Minimal payload: omit fields only when omission == explicit empty/null.
- Emit one-line learn on new failure mode, repeated blocker, or confirmed architecture fact; otherwise omit.
- Match project style; omit boilerplate.
- Use minimal bullets; never speculate.
- Treat source code as read-only truth; document exactly the actual stack.
Before you install
- Read the whole file first. Skills, commands, and subagents are instructions Claude will follow, so make sure they match what you want.
- Check which tools, scripts, or MCP servers it uses. Local servers and scripts run with your permissions.
- Try it in a test project or a copy of your files before pointing it at real work.
- Pin the version you tested, and review changes before updating.
- Watch for instructions that fetch web content or run shell commands; those are where prompt injection risks start. See our prompt injection guide.
FAQ
What is Gem Documentation Writer?
Gem Documentation Writer is a subagent for Claude Code and Claude Cowork from the github/awesome-copilot repository on GitHub. Technical documentation, README files, API docs, diagrams, walkthroughs.
How do I install Gem Documentation Writer in Claude Code?
Download gem-documentation-writer.agent.md from the repository. Save it to ~/.claude/agents/ to use it in every project, or to .claude/agents/ inside one project to share it through version control. Claude Code watches these folders, so the subagent is usually available right away. Ask Claude to use it by name, or @-mention it to make sure it runs.
Can I use Gem Documentation Writer in Claude Cowork?
Cowork loads subagents through plugins. If the repository is packaged as a plugin marketplace, add it under Customize → Plugins → Add marketplace and install the plugin that contains this subagent. Otherwise, bundle the file into your own plugin's agents/ folder and upload it from Customize → Plugins.
Is Gem Documentation Writer safe to install?
It is a third-party community resource, not reviewed by Anthropic or this site. Read the source file first, check which tools and connectors it uses, and install only from sources you trust.
Similar resources
- Prompt Engineer A specialized chat mode for analyzing and improving prompts. Every user input is treated as a prompt to be improved. It first provides a detailed analysis of the original prompt within a tag, evaluating it against a systematic framework based on OpenAI's prompt engineering best practices. Following the analysis, it generates a new, improved prompt. Subagent · github/awesome-copilot
- Prompt Builder Expert prompt engineering and validation system for creating high-quality prompts - Brought to you by microsoft/edge-ai Subagent · github/awesome-copilot
- Python Notebook Sample Builder Custom agent for building Python Notebooks in VS Code that demonstrate Azure and AI features Subagent · github/awesome-copilot
- Python Mcp Development Complete toolkit for building Model Context Protocol (MCP) servers in Python using the official SDK with FastMCP. Includes instructions… Plugin · github/awesome-copilot
- Gem Implementer TDD code implementation: features, bugs, refactoring. Never reviews own work. Subagent · github/awesome-copilot
- Gem Devops Infrastructure deployment, CI/CD pipelines, container management. Subagent · github/awesome-copilot
- Gem Orchestrator The team lead: Orchestrates planning, implementation, and verification. Subagent · github/awesome-copilot
- Gem Browser Tester E2E browser testing, UI/UX validation, visual regression. Subagent · github/awesome-copilot