documentation

A documentation guide for writing READMEs, API references, architecture decision records, and user guides. It provides templates and advice for keeping documentation with the code.

In plain words
What is it for?
For documenting projects, APIs, important technical decisions, and step-by-step tasks for users.
Why use it?
It helps teams write documentation for the right audience and avoid examples or instructions that become inaccurate over time.

Skill for Claude CodeCodex

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.

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

Made for: Claude Code, Codex.

Per session 38 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 451 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00038 $0.00451
Opus 5 $0.00019 $0.00226
Sonnet 5 $0.00008 $0.00090
Haiku 4.5 $0.00004 $0.00045

Measured 2d ago against content hash 1c0652a2846c, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation scanned grade A with 0 findings 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 2d 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.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

plugins/pokayokay/skills/documentation/SKILL.md · 50 lines

What it actually says

Documentation

Create clear, maintainable technical documentation that serves your audience.

Key Principles

  • Documentation as code — docs live with code, version with code, review with code
  • Audience-first writing — write for who's reading, not what you know
  • Maintainability over completeness — inaccurate docs are worse than no docs
  • Link to source of truth — don't duplicate information across docs

Quick Start Checklist

  1. Identify documentation type (README, API docs, ADR, user guide)
  2. Determine audience (all users, developers, team, contributors)
  3. Follow type-specific template from references
  4. Include working examples (test them!)
  5. Link to related documentation

Documentation Types

Type When to Use Audience
README Project entry point All users
API Docs Endpoint reference Developers
ADR Major decisions Team/future devs
User Guide Task completion End users

When NOT to Use

  • Inline code comments — Just add comments directly; this skill is for standalone documentation artifacts
  • API design — Use api-design for designing APIs; this skill documents existing APIs

References

Reference Description
readme-guide.md README templates, section patterns, badges
api-docs.md API documentation patterns, OpenAPI integration
adr-guide.md Architecture Decision Record format and workflow
diagrams.md Mermaid diagram patterns for common scenarios
readme-template.md Template for project README files
adr-template.md Template for Architecture Decision Records
Files

What ships with it

6 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 2d ago First seen · 50 lines · 38 tokens per session scan A 1c0652a2846c

Subscribe to this mod's changes

documentation is a skill published in the GitHub repository srstomp/pokayokay (9 stars, last pushed 1mo ago), licensed MIT. It adds 38 tokens to every session and 451 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens