update-docs

A documentation-update procedure for keeping project guides, architecture notes, agent instructions, and release notes aligned with code changes.

In plain words
What is it for?
Use it before committing or pushing changes to review the relevant documentation and record what changed.
Why use it?
It reduces the risk that documentation becomes outdated after scripts, workflows, features, or project structure change.

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/ecodan/cicadas/update-docs
Any agent
npx skills add ecodan/cicadas --skill update-docs
Clone the repo
git clone --depth 1 https://github.com/ecodan/cicadas

Made for: Claude Code, Codex.

Per session 52 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 774 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.00052 $0.00774
Opus 5 $0.00026 $0.00387
Sonnet 5 $0.00010 $0.00155
Haiku 4.5 $0.00005 $0.00077

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

Security

Grade A, and why

update-docs 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.

.claude/skills/update-docs/SKILL.md · 67 lines

How it starts

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

Update Docs

Update the six canonical documentation files to reflect recent changes before a commit or push.

Files to Update

File Purpose Update Trigger
README.md High-level intro, version, installation, quick-start Script changes, workflow changes, version bump
HOW-TO.md Full user guide (install, greenfield, brownfield, skills) Workflow changes, new features, installation changes
src/cicadas/README.md Technical breakdown of the orchestrator Script changes, directory structure changes
release-notes.md Changelog — one entry per release Always: add a new entry describing what changed
agents.md Project overview for agents Structural or architectural changes
CLAUDE.md Claude Code guidance: commands, architecture, conventions Script changes, new files, test convention changes
docs/cicadas-method-general.md general manual for cicadas method

Process

1. Understand What Changed

git diff HEAD
git status

If the user provided arguments ($ARGUMENTS), treat them as additional context about the nature of the change.

2. Read Each Doc File

Read all six files before making any edits. Understand their current state.

3. Determine What Needs Updating

For each file, ask: does the diff reveal something this doc now misrepresents or omits?

  • README.md: Update installation commands, version string, or workflow description if affected.
  • HOW-TO.md: Update the relevant section if a workflow step, command, or skill registration process changed.
  • src/cicadas/README.md: Update script listings, directory structure, or operational formulas if scripts were added/renamed/removed.
  • release-notes.md: Always add a new entry at the top (under # Release Notes) in the format:
    ## Version X.Y.Z
    - **Category**: Description of change.
    
    Infer the version bump: patch for fixes/docs, minor for new features, major for breaking changes.
  • agents.md: Update if the top-level project structure, key directories, or agent roles changed.
  • CLAUDE.md: Update commands, architecture description, or test conventions if scripts, tests, or project structure changed.

Read the full file on GitHub · 67 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. 2d ago First seen · 67 lines · 52 tokens per session scan A 5ed46f935b30

Subscribe to this mod's changes

update-docs is a skill published in the GitHub repository ecodan/cicadas (9 stars, last pushed 1mo ago), licensed Apache-2.0. It adds 52 tokens to every session and 774 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-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

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