docs-agent

Synthesize API documentation, ADR indexes, onboarding guides, and changelogs from approved implementations.

Updated Apr 4, 2026
One-click install
npx skills add https://github.com/asalhamed/dev-agents --skill docs-agent-asalhamed
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-agent
Source: https://github.com/asalhamed/dev-agents/tree/main/docs-agent
Command: npx skills add https://github.com/asalhamed/dev-agents --skill docs-agent-asalhamed

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation teams spend excessive time manually maintaining API docs, ADR indexes, onboarding guides, and changelogs after implementations, leading to outdated or inconsistent references.

Core Features & Use Cases

  • Generate and update OpenAPI documentation from approved implementations
  • Maintain ADR indexes, bounded context maps, onboarding guides, and changelogs
  • Produce up-to-date README content and onboarding materials for new teammates
  • Validate outputs against established templates and references

Quick Start

After finishing implementation, run the Documentation Agent to refresh all documentation artifacts for the project.

Frequently Asked Questions about docs-agent

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate API documentation from approved implementations?

You can automate API documentation generation by synthesizing up-to-date OpenAPI docs directly from approved implementations. The agent validates outputs against established templates to ensure your documentation reflects the current system state.

What is the best way to maintain ADR indexes and bounded context maps?

The best way to maintain ADR indexes and bounded context maps is to automate their generation from approved implementations. This ensures your architecture decisions consistently reflect the current system state across all API services.

Can I automatically update onboarding guides and changelogs after finishing an implementation?

Yes, you can automatically update onboarding guides and changelogs after finishing an implementation. Running a documentation agent refreshes these artifacts to ensure your reader guides reflect the current system state.

Does automated documentation generation work with OpenAPI templates?

Yes, automated documentation generation works with OpenAPI templates. The agent ensures all synthesized API docs conform to these established templates and validates outputs against your project references.

How do I keep README content and API docs consistent across multiple API services?

To keep README content and API docs consistent across multiple API services, apply an automated documentation agent across your bounded contexts. It produces up-to-date README materials and validates all outputs.