documentation

Solid

Generate READMEs, API docs, changelogs, and knowledge base articles. Covers README structure with personality, OpenAPI-based API documentation, changelogs from conventional commits, typedoc patterns, and support KB articles.

AI & Automation 96 stars 12 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 91/100

Stars 20%
66
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Documentation Write docs that developers actually read. Based on Stripe API docs, Standard Readme, Keep a Changelog, and OpenAPI. ## Sub-Commands | Command | Description | |---------|-------------| | `readme` | Generate a README from project files | | `api` | Generate API docs from OpenAPI spec or route handlers | | `changelog` | Generate changelog from conventional commits | | `kb` | Write a knowledge base article | ## README Structure ``` # Project Name [Badges] > One-line description ## Features (3-6 quantified benefits) ## Quick Start — copy-paste runnable (no placeholders, no omitted imports) ## API Reference — every export in table format ## Examples — 2-3 real-world scenarios ## Configuration — env vars, config file, CLI flags ## Contributing — dev setup commands ## License — SPDX identifier ``` ### The Hook (first paragraph) Answers: what (5 words), who, why. Bad: "A React component library for building modern user interfaces." Good: "Buttons, modals, forms, done right. No design debt. Zero dependencies." ### Quick Start Rules Copy-paste runnable. No omitted imports. No placeholders. No "coming soon". Include expected output. ### Badge Requirements | Badge | Required? | |-------|-----------| | CI (build status) | Yes | | Package version | Yes | | License | Yes | | Coverage | Recommended | ## API Documentation ### Structure per Endpoint ``` ### [METHOD] [Path] **Description**: one sentence **Auth required**: Yes/No [type] **Request**: Headers, Paramet...

Details

Author
EliasOulkadi
Repository
EliasOulkadi/shokunin
Created
1 months ago
Last Updated
yesterday
Language
HTML
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category