creating-documentation

Guidance for creating and reviewing README files and other repository documentation, with rules for clarity, accessibility, structure, and writing style.

In plain words
What is it for?
Writing or reviewing README files, creating contribution guides, organizing documentation, and checking it for accessibility and discoverability.
Why use it?
It helps documentation explain a project clearly to users and contributors instead of leaving important setup and contribution details unclear.

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/willvelida/code-minions/creating-documentation
Any agent
npx skills add willvelida/code-minions --skill creating-documentation
Clone the repo
git clone --depth 1 https://github.com/willvelida/code-minions

Made for: Claude Code, Codex.

Per session 60 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 693 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.00060 $0.00693
Opus 5 $0.00030 $0.00347
Sonnet 5 $0.00012 $0.00139
Haiku 4.5 $0.00006 $0.00069

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

Security

Grade A, and why

creating-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.

packages/creating-documentation/skills/creating-documentation/SKILL.md · 75 lines

How it starts

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

Creating Documentation

Overview

This skill provides capabilities for creating and reviewing README files and other repository documentation that follows established best practices for structure, accessibility, and user experience.

Good documentation is the front door to your project. It helps users understand what your project does, how to use it, and how to contribute. This skill ensures documentation is clear, accessible, and follows industry standards.

Capabilities

Capability Action Description
Create README actions/create-readme.md Generate a comprehensive README for a repository
Create CONTRIBUTING actions/create-contributing.md Generate contribution guidelines
Review actions/review-documentation.md Analyse existing documentation for quality and accessibility

Standards

This skill bundles the following standards in standards/:

Standard File Description
README Structure readme-structure.md Essential sections and organization for README files
Accessibility accessibility.md Accessibility requirements for inclusive documentation
Writing Style writing-style.md Plain language and readability guidelines
Markdown markdown.md Markdown formatting best practices
Checklist checklist.md Consolidated compliance and quality checklist

Principles

1. Audience First

Write for your audience. A README's primary purpose is to help visitors quickly understand your project and get started. Don't assume prior knowledge—provide context and links for unfamiliar concepts.

2. Progressive Disclosure

Present information in order of importance:

  • Title & Description: What is this project? (immediate)
  • Installation & Usage: How do I use it? (primary)
  • Contributing & License: How can I help? (secondary)

3. Accessibility Matters

Documentation should be accessible to all users:

  • Use proper heading hierarchy (don't skip levels)
  • Provide alt text for all images
  • Write descriptive link text (not "click here")
  • Use plain language and short sentences

Read the full file on GitHub · 75 lines

Files

What ships with it

8 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 · 75 lines · 60 tokens per session scan A 24f2509061b1

Subscribe to this mod's changes

creating-documentation is a skill published in the GitHub repository willvelida/code-minions (23 stars, last pushed 2mo ago), licensed Apache-2.0. It adds 60 tokens to every session and 693 once invoked, about $0.0003 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-30.

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

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

babysit-pr

Babysit a GitHub pull request after creation by continuously polling review comments, CI checks/workflow runs, and mergeability state until the PR is merged/closed or user help is required. Diagnose failures, retry likely flaky failures up to 3 times, auto-fix/push branch-related issues when appropriate, and keep…

openai/codex · 114 tokens

imagegen

Generate or edit raster images when the task benefits from AI-created bitmap visuals such as photos, illustrations, textures, sprites, mockups, or transparent-background cutouts. Use when Codex should create a brand-new image, transform an existing image, or derive visual variants from references, and the output…

openai/codex · 113 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

next-cache-components-optimizer

Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…

vercel/next.js · 170 tokens