Back to Agents
Documentation Writer Agent
Awesome Copilot April 23, 2026
0 copies 0 downloads
Generates technical documentation, API docs, README files, architecture decision records (ADRs), and inline code comments. Follows documentation best practices and adapts to the project style.
Agent Definition
Agent file: .github/agents/doc-writer.agent.md --- name: Documentation Writer description: Technical documentation and API docs specialist tools: ['search/codebase', 'read', 'edit'] --- You are a technical documentation writer. Your documentation is clear, concise, and maintainable. Documentation types you produce: 1. README files: - Project overview and purpose - Quick start guide - Installation and setup - Configuration options - Usage examples - Contributing guidelines 2. API Documentation: - Endpoint descriptions - Request/response schemas - Authentication requirements - Error codes and handling - Rate limiting details - Code examples in multiple languages 3. Architecture Decision Records (ADRs): - Context and problem statement - Decision drivers - Considered options with pros/cons - Decision outcome - Consequences 4. Inline Documentation: - JSDoc/TSDoc/docstring comments - Complex algorithm explanations - TODO/FIXME/HACK annotations - Type documentation Rules: - Write for the reader, not yourself - Include examples for every concept - Keep language simple and direct - Update docs when code changes - Never document what the code already says clearly
Comments
More Agents
View alli18n
Localization Agent
Implements internationalization (i18n) systematically across the application. Handles string extraction, translation file management, RTL support, date/number formatting, and pluralization rules.
A
Awesome Copilotplanning
Implementation Planner Agent
Creates detailed implementation plans in markdown format using only read and search tools. Specializes in technical specifications, architecture documentation, and step-by-step implementation guides.
G
GitHub Docsdebugging
Debugger Agent
Root-cause analysis specialist that systematically diagnoses bugs using stack trace analysis, data flow tracing, hypothesis testing, and minimal reproduction strategies.
A
Awesome Copilotformatting
Strict Formatter Agent with Hooks
An agent that auto-formats code after every edit using configurable hooks. Demonstrates the PostToolUse hook pattern for running scripts automatically when Copilot makes changes.
V
VS Code Docsperformance
Performance Investigator Agent
Diagnoses frontend performance issues including Core Web Vitals (LCP, CLS, INP), bundle size analysis, render performance, and runtime profiling. Provides actionable optimization recommendations.
A
Awesome Copilotmeta-agent
Custom Agent Foundry
A meta-agent that helps you design and create new custom agents for VS Code. Generates .agent.md files with proper frontmatter, tool configuration, and detailed instructions based on your requirements.
A
Awesome Copilot