auto_documentation

Generate changelogs, API docs, and deployment reports for CI/CD pipelines.

1|3|Updated Feb 20, 2026

Search Tags:#automation #changelog #documentation #infrastructure #deploy #api-docs

Ready to run

npx skills add https://github.com/midnghtsapphire/revvel-standards --skill auto-documentation-midnghtsapphire

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: auto_documentation
Source: https://github.com/midnghtsapphire/revvel-standards/tree/main/skills/auto-documentation
Command: npx skills add https://github.com/midnghtsapphire/revvel-standards --skill auto-documentation-midnghtsapphire

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manual documentation tends to lag behind code changes, deployments, and configurations, leaving teams with incomplete traces of history. This skill automates consistent creation and maintenance of changelogs, API documentation, and deployment records.

Core Features & Use Cases

Automatic generation and updating of CHANGELOG.md in the repository root aligned with semantic-versioning.
API documentation generation using OpenAPI/Swagger or TypeDoc and hosting via GitHub Pages or /docs.
Deployment and infrastructure artifacts (DEPLOY_REPORT.md, INFRASTRUCTURE_MAP.md, SPRINT_STATE.md) auto-generated or updated during workflows.
Use Case: when releasing a new version, automatically produce a changelog, update API docs, and log deployment results.

Quick Start

Configure your project to enable automatic documentation so every change, build, and deployment is captured and stored.

Frequently Asked Questions about auto_documentation

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

FAQPage Schema

How do I automatically generate a changelog for every code change and deployment?▼

Automatic changelog generation creates and updates a CHANGELOG.md file in your repository root, capturing every code change aligned with semantic-versioning during CI/CD workflows. This ensures your deployment history stays synchronized with actual code modifications.

What is the best way to keep API documentation updated without manual effort?▼

Automated API documentation generation uses OpenAPI or Swagger to produce docs and hosts them via GitHub Pages or a /docs directory. It updates your API documentation automatically during builds, eliminating manual maintenance lag between code changes and published references.

How do I create deployment and infrastructure reports during a release?▼

Deployment reports are auto-generated as DEPLOY_REPORT.md and INFRASTRUCTURE_MAP.md artifacts during your release workflows. They log deployment results and map infrastructure configurations automatically, providing a consistent trace of every release without manual intervention.

Does auto documentation work with existing CI/CD pipelines for project tracking?▼

Yes, this approach integrates directly with CI/CD pipelines to capture changes, builds, and deployments automatically. It enforces artifacts like CHANGELOG.md, DEPLOY_REPORT.md, and SPRINT_STATE.md, ensuring every workflow produces consistent documentation artifacts.

Why does my project documentation lag behind code changes and deployments?▼

Manual documentation tends to lag because it relies on developers remembering to update records after changes. Automating the creation of changelogs, API docs, and deployment reports during CI/CD workflows eliminates this gap and ensures comprehensive project history.

Can I generate OpenAPI documentation and host it on GitHub Pages automatically?▼

Yes, automated documentation workflows generate API docs using OpenAPI or Swagger and host them via GitHub Pages or a /docs directory. This happens automatically during builds, ensuring your published documentation always reflects the current state of your codebase.