Documentation

What it does

When your agent uses it

• Tasks that involve Technical documentation
• Tasks that involve Changelog and release notes
• Tasks that involve OpenAPI specifications

Example prompts

• “/documentation”

Requirements

• Node.js
• Compatibility (from SKILL.md): opencode
• Pre-approved tools (allowed-tools): read, write, edit, glob, grep, bash, webfetch

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

1. 1Identify document type — README, API docs, changelog, or knowledge base article. Each has a distinct structure and rule set.
2. 2Gather source material — for README: project files, package.json, build system. For API: OpenAPI spec or route handlers. For changelog…
3. 3Apply the template — README: hook → features → quick start → API → examples → config → contributing → license. API: method → path →…
4. 4Fill every section with real data — no "TODO", "coming soon", "TBD", placeholder text. Quick start must be copy-paste runnable. API docs…
5. 5Verify everything — test quick start from clean environment. Check every link resolves. Confirm license badge matches LICENSE file. KB…
6. 6Cut the generic — remove default template comments. Strip "write unit tests" style advice. Every sentence must convey a specific…

What it can do on your machine

Read from SKILL.md and the folder at commit 4c68e5b. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves these tools, so the agent can use them without asking each time:

  • read
  • write
  • edit
  • glob
  • grep
  • bash
  • webfetch

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  Shell commands in SKILL.md call:

  • npx

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  No URLs in SKILL.md. Its commands use npx, which can reach the network depending on how they are called.

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names no API keys, tokens, secrets or passwords.

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

• Compatibility

  opencode

  From compatibility in the SKILL.md frontmatter.

Context cost

Documentation loads about 2k tokens when it runs. Until then it costs about 60 tokens; SKILL.md has 782 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~60

When it runs · the whole SKILL.md, loaded when a task matches

~2k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from EliasOulkadi/shokunin at commit 4c68e5b, republished under its MIT licence (© EliasOulkadi). 782 words, ~2,034 tokens.

name

documentation

description

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.

allowed-tools

read, write, edit, glob, grep, bash, webfetch

compatibility

opencode

triggers

write documentation, write README, API documentation, API docs, changelog, release notes, knowledge base, setup guide, getting started, project docs

negatives

API design, code comments, blog post, technical writing prose

license

MIT

metadata.version

4.0.0

metadata.workflow

documentation

metadata.audience

developers

# 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

### [METHOD] [Path]
**Description**: one sentence
**Auth required**: Yes/No [type]
**Request**: Headers, Parameters (path/query/body)
**Response 200**: Body with example
**Error responses**: 400, 401, 404, 500 with descriptions

## [2.1.0] - 2026-05-16

### Added
- New feature (#PR)

### Changed
- Behavior change with migration note (#PR)

### Fixed
- Bug fix (#PR)

### Deprecated / Removed / Security

Title: as a question user would search for
Context: 1-2 sentences — who, what product/feature
Steps: numbered, one action per step, action verb first
Expected result: after last step
Escalation: if it still doesn't work

npx @redocly/cli build-docs openapi.yaml -o docs.html
npx @scalar/api-reference openapi.yaml

# Generate from conventional commits
npx standard-version
npx changelogen --from v1.0.0 --to HEAD

# Keep a Changelog format
## [version] - YYYY-MM-DD
### Added | Changed | Deprecated | Removed | Fixed | Security

© EliasOulkadi, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .pack/skills/documentation of EliasOulkadi/shokunin.

Open the folder on GitHubat commit 4c68e5b