skills.rest
EliasOulkadi
EliasOulkadiCOMMUNITY
Explore all skills by this author →
𝕏@EliasOulkadiGitHub

documentation

Generate READMEs, API reference sections, changelogs, and knowledge base articles from project inputs.

110|14|Updated May 12, 2026
Search Tags:#documentation#conventional commits#openapi#knowledge base#api reference#readme generation#changelog automation
One-click install
npx skills add https://github.com/EliasOulkadi/shokunin --skill documentation-eliasoulkadi
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/EliasOulkadi/shokunin/tree/main/.pack/skills/documentation
Command: npx skills add https://github.com/EliasOulkadi/shokunin --skill documentation-eliasoulkadi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents inconsistent, incomplete, and outdated project documentation by generating docs that follow proven standards.

Core Features & Use Cases

  • README generation: Produce a complete README with a strong hook, quantified features, a copy-paste Quick Start, and verified badges.
  • API documentation: Create endpoint docs from OpenAPI specs or route handlers, including requests, responses, and error status coverage.
  • Changelog and KB articles: Generate Keep a Changelog-style entries from conventional commits and produce searchable, step-based knowledge base articles.

Quick Start

Ask the agent to write documentation for your repository by generating the README, API docs, a changelog, and a knowledge base article.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate a README and API documentation from an OpenAPI spec?▼

Generate READMEs and API documentation from OpenAPI specs by producing template-compliant sections with copy-paste Quick Start guidance and full request, response, and error status coverage. The Skill extracts endpoint details to create standardized onboarding docs.

Can I automate changelog generation from conventional commits?▼

Automate changelog generation from conventional commits by producing Keep a Changelog-style entries. The Skill parses commit messages to create standardized, chronological updates for software projects.

What is the best way to create searchable knowledge base articles for a software project?▼

Create searchable knowledge base articles by generating step-based KB content derived from product expertise or project inputs. The Skill formats this content for standardized onboarding and developer reference.

Does this documentation generation approach require any specific dependencies or components?▼

Documentation generation requires no specific dependencies or components. It operates independently using provided project inputs, OpenAPI specs, or conventional commits to produce standardized documentation artifacts.

How do I ensure my API reference includes full request, response, and error documentation?▼

Ensure full API reference documentation by generating endpoint docs from OpenAPI specs or route handlers. The Skill automatically produces complete request, response, and error status coverage in template-compliant sections.

Related Skills

Explore More Content & Communication Skills→
jhlee0409jhlee0409
4

openapi-parser

Parse OpenAPI 3.x and Swagger 2.0 specs into structured endpoint catalogs.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
zhangzhang-111-izhangzhang-111-i
2

changelog-generator

Generate changelog entries from Conventional Commits in markdown or JSON.

Community
Intermediate
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced