ag-documentar-projeto

Automatically updates and generates project documentation from code changes.

19|4|Updated Mar 7, 2026
One-click install
npx skills add https://github.com/andregusman-raiz/a-gusman-claude --skill ag-documentar-projeto
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ag-documentar-projeto
Source: https://github.com/andregusman-raiz/a-gusman-claude/tree/main/skills/ag-documentar-projeto
Command: npx skills add https://github.com/andregusman-raiz/a-gusman-claude --skill ag-documentar-projeto

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically keep project documentation in sync with code changes, reducing drift and manual effort.

Core Features & Use Cases

  • Auto-update README, API docs, guides, and ADRs when the codebase changes.
  • Generate missing documentation from code metadata and templates.
  • Use Case: You refactor a module and want the README and API docs to reflect the new endpoints and usage.

Quick Start

Update the project docs to reflect the latest code changes.

Frequently Asked Questions about ag-documentar-projeto

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

FAQPage Schema
How do I automatically keep project documentation in sync with code changes?

You can keep project documentation in sync by applying template-driven generation and incremental updates to README, API docs, guides, and ADRs whenever significant code changes occur. This process validates artifacts to ensure they stay aligned with the codebase.

What is the best way to update README and API docs after refactoring a module?

Updating README and API docs after a refactor is best handled through cross-format synchronization, which automatically updates or generates missing artifacts to reflect new endpoints and usage based on code metadata.

Can I generate missing ADRs and guides automatically from code metadata?

Yes, you can generate missing ADRs and guides automatically from code metadata using template-driven generation. This creates the necessary documentation artifacts and applies validation to ensure they remain aligned with the codebase.

Does automated documentation generation work for repositories with existing guides and API docs?

Automated documentation generation works for repositories with existing guides and API docs by applying incremental updates. It updates or generates artifacts when significant code changes occur, preventing drift without overwriting existing valid content.

Why does documentation drift occur and how do incremental updates prevent it?

Documentation drift occurs when manual updates lag behind code changes. Incremental updates prevent drift by applying cross-format synchronization and validation to update README, API docs, guides, and ADRs automatically whenever significant codebase modifications happen.