documentation

Generate and maintain API documentation, OpenAPI specs, SDKs, and changelogs.

4|Updated Dec 23, 2025
One-click install
npx skills add https://github.com/89jobrien/steve --skill documentation-89jobrien
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/89jobrien/steve/tree/main/steve/skills/documentation
Command: npx skills add https://github.com/89jobrien/steve --skill documentation-89jobrien

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive documentation capabilities, including API documentation, OpenAPI specs, SDK generation, migration guides, architecture docs, ADRs, changelogs, and user guides, reducing manual writing and improving developer experience.

Core Features & Use Cases

  • OpenAPI/Swagger spec creation
  • SDK generation and interactive docs
  • Versioning, migrations, and migration guides
  • User guides, tutorials, and READMEs
  • Changelog generation and architecture docs

Quick Start

Create an OpenAPI specification for your REST API to start documenting endpoints and usage.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate OpenAPI documentation from my REST API?

OpenAPI specification creation automates endpoint documentation by defining your REST API structure, parameters, and responses in a machine-readable format. This generates interactive docs, client SDKs, and validates API contracts without manual writing.

Can I auto-generate changelogs from Git commits?

Changelog generation from Git commits automatically extracts and organizes commit history into versioned release notes. This reduces manual effort and ensures changelog accuracy by parsing commit messages into structured release documentation.

What's the best way to document API migrations and breaking changes?

Migration guides pair versioning and architecture documentation to explain breaking changes, upgrade paths, and deprecation timelines. This helps developers understand how to transition between API versions and reduces support burden.

Does this support multi-language SDK generation from API specs?

SDK generation from OpenAPI specs creates client libraries in multiple languages automatically. This accelerates developer onboarding and maintains consistency across language-specific implementations without hand-coding each SDK.

How do I document architecture decisions and design rationale?

ADR (Architecture Decision Record) documentation captures design decisions, context, and rationale in structured formats. This preserves architectural knowledge and helps team members understand why specific choices were made.

Can I generate user guides and READMEs automatically?

README and user guide generation creates comprehensive documentation from API specs and configuration metadata. This provides developers with getting-started instructions and usage examples without manual composition.