documentation

documentation is a skill for Claude Code from EliasOulkadi/shokunin. It costs 47 tokens per session (1,893 once invoked), scanned A, original, MIT.

A documentation-writing guide for software projects. It covers README files, API documentation from OpenAPI specifications or route handlers, changelogs from conventional commits, and knowledge-base articles.

In plain words
What is it for?
Use it to generate or improve a README, document an API, create a changelog, or write support and knowledge-base content.
Why use it?
It helps turn project code and commit history into usable explanations without leaving missing setup, configuration, or reference details. It also encourages runnable examples and consistent document structure.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter. Also seen: mentions OpenCode.

Good fit Use it to generate or improve a README, document an API, create a changelog, or write support and knowledge-base content.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/eliasoulkadi/shokunin/documentation
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add EliasOulkadi/shokunin --skill documentation
Clone the repo
git clone --depth 1 https://github.com/EliasOulkadi/shokunin

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/eliasoulkadi/shokunin/documentation/github.svg)](https://agentmods.dev/skills/eliasoulkadi/shokunin/documentation)
Your own site
<a href="https://agentmods.dev/skills/eliasoulkadi/shokunin/documentation"><img src="https://agentmods.dev/badge/skills/eliasoulkadi/shokunin/documentation/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for documentation

Your own site · 80×15
<a href="https://agentmods.dev/skills/eliasoulkadi/shokunin/documentation"><img src="https://agentmods.dev/badge/skills/eliasoulkadi/shokunin/documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 47 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,893 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. A grade says what 26 rules found in the file — not that it is safe. Third-party audits
  • NVIDIA SkillSpector warn 7 Sept 2026
SkillSpector: 4 findings, up to medium

These are SkillSpector’s own severities. On a checked sample its high-severity flags on skills were ~96% false positives — a documented command, a public API, a “never do X” rule — so we show them as a caution to read, not a verdict. Why →

  • medium MCP Rug Pull · line 182
    npx commands without a version suffix (e.g. @1.0.0) create a rug-pull risk if the upstream server is compromised and publishes a malicious update.
    Fix: Pin the version: npx @scope/[email protected]
  • medium MCP Rug Pull · line 183
    npx commands without a version suffix (e.g. @1.0.0) create a rug-pull risk if the upstream server is compromised and publishes a malicious update.
    Fix: Pin the version: npx @scope/[email protected]
  • medium MCP Rug Pull · line 193
    npx commands without a version suffix (e.g. @1.0.0) create a rug-pull risk if the upstream server is compromised and publishes a malicious update.
    Fix: Pin the version: npx @scope/[email protected]
  • medium MCP Rug Pull · line 194
    npx commands without a version suffix (e.g. @1.0.0) create a rug-pull risk if the upstream server is compromised and publishes a malicious update.
    Fix: Pin the version: npx @scope/[email protected]
How audits are shown
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00047 $0.01893
Opus 5 $0.00023 $0.00946
Sonnet 5 $0.00009 $0.00379
Haiku 4.5 $0.00005 $0.00189

Measured 9d ago against content hash 792264f5f2a9, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, from the pricing page.

Security

Grade A, and why

documentation scanned grade A with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 9d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

- [ ] Request example (curl + one SDK)
.pack/skills/documentation/SKILL.md · 219 lines

How it starts

The opening of the file, as written. The whole thing — 219 lines — stays where its author put it; the contents beside it link to each section on GitHub.

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, Parameters (path/query/body)
**Response 200**: Body with example
**Error responses**: 400, 401, 404, 500 with descriptions

Rules per Endpoint

  • Request example (curl + one SDK)
  • Response example with ALL fields
  • Error responses for ALL possible status codes
  • Pagination docs (if applicable)
  • Rate limit headers documented

Changelog Format

## [2.1.0] - 2026-05-16

### Added
- New feature (#PR)

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

### Fixed
- Bug fix (#PR)

### Deprecated / Removed / Security

Read the full file on GitHub · 219 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 9d ago First seen · 219 lines · 47 tokens per session scan A 792264f5f2a9

Subscribe to this mod's changes

documentation is a skill published in the GitHub repository EliasOulkadi/shokunin (113 stars, last pushed 1mo ago), licensed MIT. It adds 47 tokens to every session and 1,893 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

memcord

Privacy-first, self-hosted chat memory for OpenClaw — save and recall conversation history across sessions without any cloud dependency.

ukkit/memcord · 28 tokens

python-docs

Create, update, and sync Python project documentation from source code. Use when asked to document a module, generate API references, create architecture diagrams with Mermaid, update docs after code changes, or keep documentation in sync with source. Triggers include "document", "write docs", "update docs", "sync…

arnabdeypolimi/claude_code_setup · 98 tokens

code-refactor

Refactor Python code to match this repo's coding standards and style. Use when the user asks to "refactor", "clean up", "fix coding standards", or "apply best practices" to a module, file, or directory in this repo. Applies python-best-practices, pydantic v2, pytorch-lightning, and python-docs conventions as relevant…

arnabdeypolimi/claude_code_setup · 85 tokens

quality

PALADIN quality gatekeeper. Two-stage system: Stage 1 checks spec compliance (pass/fail, blocks everything on failure). Stage 2 scores project health 0-100 across 6 tiers. Issues verdict: SHIP IT / SHIP WITH CAUTION / NOT READY / BLOCKED. Evidence Before Claims: every finding must cite the file, line, and what was…

pnmcguire480/cairntir · 141 tokens

refresh

Use when an existing contextualizer's references may have drifted from current upstream state — typically weekly, or whenever a few days of upstream changes have accumulated — to bring them back into agreement.

nick-railsback/skill-engine · 40 tokens

distill-habits

Review recent Claude Code conversations, distill the user's stable habits and preferences, persist them into a long-term habit ledger, and maintain a "My Habits" block in the global CLAUDE.md within a character budget. The more you use Claude Code, the more it knows you. Trigger manually with /distill-habits, or on a…

betayyang/claude-habit-distiller · 87 tokens