documentation

仓库创建 2026年5月12日最近提交 7 小时前SkillHot 收录 20 天前

▸ 精选理由

基于 OpenAPI 与约定式提交能快速产出工程文档

这个 Skill 做什么

自动生成 README、API 文档、更新日志与知识库文章

自动帮你生成项目的 README、API 文档、更新日志和知识库文章，能从项目文件或 OpenAPI 规范提取内容并成稿。适合需要把代码/接口说明写成可读文档，或把提交记录生成 changelog 的场景。特点是结合 Stripe/Standard Readme 和 Keep a Changelog 的写法，有结构、有语气还能对接 OpenAPI 输出。

▸ 展开 SKILL.md 英文原文

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.

内容创作文档生成API文档CHANGELOG通用

110

Stars

Forks

仓库内 Skill

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/EliasOulkadi/shokunin/master/.pack/skills/documentation/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/EliasOulkadi/shokunin/master/.pack/skills/documentation/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# 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

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有