agent-documentation-writer

Specialist subagent: Generates comprehensive documentation including READMEs, API docs, architecture docs, and inline comments.

Skill by travisjneuman

IndexedMIT★ 106

Write a review

Install

Works with Claude Code, Claude apps, Codex, Cursor, Gemini CLI, GitHub Copilot, VS Code, OpenCode, Goose, Windsurf. Read the repository before you give any tool access to your data.

npx agentmarket install skill/travisjneuman-agent-documentation-writer

Asks which of your tools to add it to (Claude Code, Codex, Cursor, VS Code, Windsurf, Gemini CLI, Claude Desktop) and shows the change first. See https://agentmart.dev/cli.

Get the weekly diff

The weekly diff: one email a week with new agent tools, notable updates and grade changes, plus security alerts for tools you follow. Double opt-in, one-click unsubscribe.

About

Specialist subagent: Generates comprehensive documentation including READMEs, API docs, architecture docs, and inline comments. Use when documenting code, creating guides, or explaining systems.

Use cases: backend, agent-building

Reviews

Write a review

No reviews yet. Installed it? Reviews come from verified installers only. How reviews work

Permissions

What this skill can do and what it asks for, from its SKILL.md and code. Checked Oct 25, 2026.

Tools: No tools found
Secrets: None asked for
Install scripts: None found

Network hosts it talks to 1

codeload.github.com · found in install command

Files it touches

~/.claude/skills/agent-documentation-writer

What's inside

Skill name: agent-documentation-writer
Description: Specialist subagent: Generates comprehensive documentation including READMEs, API docs, architecture docs, and inline comments. Use when documenting code, creating guides, or explaining systems.
License: MIT
Instructions: 103 lines in SKILL.md · view on GitHub

Files (1)

SKILL.md

SKILL.md (first lines)

You are a technical writer specializing in developer documentation.

## Documentation Types

### README.md

```markdown
# Project Name

Brief description (1-2 sentences)

## Features

- Key feature 1
- Key feature 2

## Quick Start

\`\`\`bash

# Installation

npm install

# Run

npm start
\`\`\`

## Configuration

[Environment variables, config files]

## Usage

[Code examples]

## API Reference

[Link or summary]

## Contributing

[Guidelines]

## License

[License type]
```

### API Documentation

- Endpoint descriptions
- Request/response schemas
- Authentication requirements
- Error codes and handling
- Rate limiting info
- Code examples in multiple languages

### Architecture Documentation

- System overview diagram
- Component responsibilities
- Data flow descriptions
- Integration points
- Deployment architecture

### Code Comments

- JSDoc/TSDoc for public APIs
- Explain "why" not "what"
- Document edge cases
- Note performance considerations

## Documentation Principles

1. Write for the reader's context
2. Lead with examples
3. Keep it current with code
4. Progressive disclosure (overview → details)
5. Searchable and scannable

## Mermaid Diagrams

```mermaid
graph TD
    A[Client] --> B[API Gateway]
    B --> C[Service A]
    B --> D[Service B]
```

## Output Quality

- Clear, concise language
- Consistent formatting
- Working code examples
- Accurate technical details
- Appropriate for audience level

## Your task

$ARGUMENTS

From travisjneuman/.claude, MIT.

Signals

Stars: 106
Forks: 26
Open issues: 2
Last commit (this folder): Sep 29, 2026 (1 month ago)

From GitHub (fetched Oct 24, 2026).

Details

License: MIT
Repository: github.com/travisjneuman/.claude
Website: claude.travisjneuman.com
First seen: Oct 24, 2026
Last checked: Oct 24, 2026
Source: GitHub github-graphql

More from travisjneuman

Cite this page

agent-documentation-writer skill. Agent Mart. https://agentmart.dev/skills/travisjneuman-agent-documentation-writer (last updated 2026-10-24)