skills.rest
ukrsite
ukrsiteCOMMUNITY
Explore all skills by this author →
GitHub

documentation-update

Generate OpenAPI 3.0 specs, Mermaid diagrams, and delta reports from codebases.

Updated Aug 23, 2026
Search Tags:#documentation#markdown#openapi#codebase#architecture-diagrams#api-spec
One-click install
npx skills add https://github.com/ukrsite/kiro-workflows --skill documentation-update-ukrsite
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-update
Source: https://github.com/ukrsite/kiro-workflows/tree/main/skills/developer-skills/documentation-update
Command: npx skills add https://github.com/ukrsite/kiro-workflows --skill documentation-update-ukrsite

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates keeping codebase documentation up to date by scanning changes and generating docs across API specs, architecture diagrams, onboarding guides, and delta reports.

Core Features & Use Cases

  • Scan codebase to identify REST endpoints (Spring Boot @RestController, FastAPI routes, Express routes)
  • Generate OpenAPI 3.0 specs from source code annotations
  • Create Mermaid diagrams (component, sequence, ER) and place diagrams in docs/diagrams/
  • Produce onboarding guides with project overview, setup, and contribution guidelines
  • Generate delta reports listing new/updated/removed content and coverage statistics

Quick Start

Run documentation-update on your repository to refresh API specs, architecture diagrams, and onboarding guides based on recent code changes

Frequently Asked Questions about documentation-update

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

FAQPage Schema
How do I auto-generate OpenAPI specs from my codebase?▼

You can auto-generate OpenAPI 3.0 specs by scanning your codebase to identify REST endpoints from Spring Boot, FastAPI, or Express source code annotations.

How do I generate architecture diagrams from source code?▼

Generate architecture diagrams from source code by scanning your codebase to create Mermaid component, sequence, and ER diagrams, placing them directly in docs/diagrams.

Can I generate onboarding guides and delta reports for my Python or Node project?▼

Yes, you can generate onboarding guides with project overviews and setup instructions, plus delta reports listing new or updated content, for Java, Python, and Node projects.

Will updating documentation overwrite existing markdown files in my repository?▼

Updating documentation includes safeguards to preserve existing docs where appropriate, ensuring your current markdown files are protected during the automated refresh process.

What is the best way to automate documentation updates across CI/CD workflows?▼

Automate documentation updates across CI/CD or local workflows by scanning codebase changes to refresh API specs, architecture diagrams, and delta reports with coverage statistics.

Related Skills

Explore More Software Engineering Skills→
winhokwinhok
5

apitestspec-surface-scan

Scan backend source code to identify HTTP API endpoints and export Markdown or JSON documentation.

Community
Intermediate
0xtaoist0xtaoist

ln-113-backend-docs-creator

Generates API spec and database schema docs from backend context using OpenAPI 3.0 and Mermaid ER diagrams.

Community
Intermediate
Baphomet480Baphomet480

cloudflare-pages

Deploy static websites to Cloudflare Pages with custom domains and CI/CD.

Community
Intermediate
B4sanB4san

documentation

Generate project documentation including READMEs, API docs, and Mermaid/PlantUML architecture diagrams.

Community
Intermediate