skills.rest
BaraArdiwinata
BaraArdiwinataCOMMUNITY
Explore all skills by this author →
GitHub

generate-docs

Generates API, component, hook and schema documentation and changelog updates for DaaS RAD Platform projects.

1|Updated May 26, 2026
Search Tags:#documentation generation#API documentation#changelog maintenance#code change tracking#UI component documentation
One-click install
npx skills add https://github.com/BaraArdiwinata/hackathon-sima-arome --skill generate-docs-baraardiwinata
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: generate-docs
Source: https://github.com/BaraArdiwinata/hackathon-sima-arome/tree/main/.agents/skills/generate-docs
Command: npx skills add https://github.com/BaraArdiwinata/hackathon-sima-arome --skill generate-docs-baraardiwinata

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pypdf, pdfplumber, pdf2image, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the documentation process for code changes, ensuring accurate and up-to-date documentation that reflects all code updates.

Core Features & Use Cases

  • API Documentation: Generates documentation for API endpoints, including method details, request/response bodies, and example calls.
  • Component Documentation: Generates detailed guides for UI components, outlining props, usage examples, and configuration.
  • Feature Documentation: Provides documentation for new features, user stories, components involved, and API endpoints.
  • Use Case: For instance, when implementing a new API endpoint or updating a UI component, this Skill automatically creates the necessary documentation to keep it aligned with the latest code changes.

Quick Start

To generate documentation for the latest API changes, execute the 'generate-docs' command and specify the 'API_ENDPOINT' feature as the argument.

Frequently Asked Questions about generate-docs

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

FAQPage Schema
How do I automate API documentation generation for code changes?▼

You can automate API documentation generation by executing a command that identifies code changes and creates appropriate templates for API endpoints, including method details, request/response bodies, and example calls.

What is the best way to maintain a changelog for DaaS RAD Platform projects?▼

The best way to maintain a changelog for DaaS RAD Platform projects is to use automated documentation tools that track code changes and automatically update CHANGELOG entries to reflect all code updates accurately.

How do I generate UI component documentation with props and usage examples?▼

Generating UI component documentation involves using automated tools that create detailed guides outlining component props, usage examples, and configuration based on the latest code changes.

Does automated documentation generation work for feature documentation and user stories?▼

Yes, automated documentation generation works for feature documentation by providing documentation for new features, user stories, components involved, and API endpoints based on code updates.

Can I use PDF processing libraries for schema file and hook documentation?▼

The documentation generation process supports schema files and hook docs, utilizing dependencies like pypdf, pdfplumber, and pdf2image to process and generate comprehensive documentation records.

Related Skills

Explore More Software Engineering Skills→
Alif-NAlif-N

generate-docs

Generate and update DaaS application documentation from JSDoc comments.

Community
Intermediate
unfinishablemapunfinishablemap
3

expand-topic

Generate a publish-ready article draft from a topic prompt.

Community
Intermediate
mkalhitti-cloudmkalhitti-cloud
2

pdf

Extract text and tables from PDF documents using Python libraries.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced