skills.rest
lunaticwithaduck
lunaticwithaduckCOMMUNITY
Explore all skills by this author →
GitHub

documentation

Guides creation of API references, READMEs, changelogs, ADRs, and documentation sites.

2|Updated Jun 8, 2026
Search Tags:#changelog#documentation#openapi#technical writing#adr#readme#storybook
One-click install
npx skills add https://github.com/lunaticwithaduck/easytech3d --skill documentation-lunaticwithaduck
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/lunaticwithaduck/easytech3d/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/lunaticwithaduck/easytech3d --skill documentation-lunaticwithaduck

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams struggle to produce consistent, maintainable technical documentation across APIs, codebases, and projects, leading to outdated docs, slow onboarding, and repeated architecture debates. ## Core Features & Use Cases - API Documentation: Author OpenAPI 3.1 specs with schemas, responses, and security definitions, then render them with Scalar, Swagger UI, or Redoc and generate TypeScript types via openapi-typescript. - Doc Sites & Component Docs: Compare and set up Mintlify, Nextra, Docusaurus, Starlight, and Fumadocs, plus Storybook stories for UI component documentation. - Project Documentation: Apply templates for READMEs, Keep a Changelog changelogs, Conventional Commits, ADRs, and JSDoc/TypeDoc patterns. - Use Case: When starting a new API, use this Skill to draft an OpenAPI spec, generate typed clients, scaffold a Mintlify doc site, and record the database choice as an ADR. ## Quick Start Ask the assistant to create an OpenAPI specification and README template for your REST API project.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I write OpenAPI documentation for a REST API?▼

Define an OpenAPI 3.1 spec with info, servers, paths, and reusable component schemas for requests, responses, and errors. Render it with Scalar, Swagger UI, or Redoc, and generate TypeScript types using openapi-typescript.

What documentation tool should I use for a Next.js project?▼

Nextra and Fumadocs integrate directly with Next.js and App Router, making them natural fits. Mintlify offers a managed alternative with built-in API reference support, while Docusaurus suits larger framework-agnostic doc sites.

How do I keep a changelog for my project?▼

Follow the Keep a Changelog format with Added, Changed, Fixed, and Deprecated sections tied to semantic versions. Automate it with Changesets for monorepos, Conventional Commits with auto-changelog, or Release Drafter on GitHub.

When should I write an ADR for architecture decisions?▼

Write an ADR for every significant technical decision, numbered sequentially and stored in docs/adr. Record context, decision, alternatives, and consequences, and supersede old ADRs rather than deleting them.

Does TypeDoc work with Markdown documentation sites?▼

Yes, TypeDoc supports the typedoc-plugin-markdown plugin, which outputs Markdown files instead of HTML. Configure entryPoints, output directory, and exclusions in typedoc.json, then run npx typedoc to generate docs.

Related Skills

Explore More Software Engineering Skills→
jtucker9jtucker9

memstack-development-api-designer

Design RESTful API routes and Zod validation schemas for Next.js.

Community
Advanced
openonionopenonion
1.3k

ship-feature

Automate end-to-end feature releases from code changes to PyPI.

Official
Advanced
spencerpaulyspencerpauly
672

adding-api-docs

Generate OpenAPI documentation from existing API routes and schemas.

Community
Intermediate
aaveaave
22

schema-update

Update SDK GraphQL schema and related types from local or staging API servers.

Official
Advanced