readme-maintenance

readme-maintenance is a skill for Claude Code from parisgroup-ai/imersao-ia-setup. It costs 56 tokens per session (1,794 once invoked), scanned A, original, MIT.

A documentation-maintenance guide for a monorepo, which is one repository containing multiple packages or applications. It audits, creates, standardizes, and checks README.md and AGENTS.md files.

In plain words
What is it for?
Use it to audit documentation, find missing files, generate READMEs from code, validate links, or fix documentation inconsistencies across packages and apps.
Why use it?
It helps find missing or inconsistent documentation and catches broken links, exports, and command references. This reduces the need to inspect every package manually.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin. Also seen: mentions AGENTS.md.

Part of the imersao plugin — 51 skills, 7 commands shipped together

Good fit Use it to audit documentation, find missing files, generate READMEs from code, validate links, or fix documentation inconsistencies across packages and apps.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/parisgroup-ai/imersao-ia-setup/readme-maintenance
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 parisgroup-ai/imersao-ia-setup --skill readme-maintenance
Clone the repo
git clone --depth 1 https://github.com/parisgroup-ai/imersao-ia-setup

Made for: Claude Code.

Or install imersao, the plugin that ships this one along with the rest of its 51 skills, 7 commands.

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 readme-maintenance

README.md
[![agentmods](https://agentmods.dev/badge/skills/parisgroup-ai/imersao-ia-setup/readme-maintenance/github.svg)](https://agentmods.dev/skills/parisgroup-ai/imersao-ia-setup/readme-maintenance)
Your own site
<a href="https://agentmods.dev/skills/parisgroup-ai/imersao-ia-setup/readme-maintenance"><img src="https://agentmods.dev/badge/skills/parisgroup-ai/imersao-ia-setup/readme-maintenance/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 readme-maintenance

Your own site · 80×15
<a href="https://agentmods.dev/skills/parisgroup-ai/imersao-ia-setup/readme-maintenance"><img src="https://agentmods.dev/badge/skills/parisgroup-ai/imersao-ia-setup/readme-maintenance.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 56 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,794 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.00056 $0.01794
Opus 5 $0.00028 $0.00897
Sonnet 5 $0.00011 $0.00359
Haiku 4.5 $0.00006 $0.00179

Measured 11d ago against content hash 3330d9baa5b2, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-11, from the pricing page.

Security

Grade A, and why

readme-maintenance 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 11d ago.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/audit-readmes.sh), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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/imersao/skills/readme-maintenance/SKILL.md · 249 lines

How it starts

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

README Maintenance

Audit, standardize, generate, and validate README.md and AGENTS.md files across the monorepo.

Purpose

Maintain consistent, accurate documentation for all packages and apps by:

  1. Auditing existing READMEs for consistency and accuracy
  2. Detecting missing documentation files
  3. Generating new READMEs from code analysis
  4. Validating links, exports, and command references
  5. Standardizing format across the monorepo

Quick Commands

Action Command
Audit all /readme audit
Check specific package /readme audit packages/api
Find missing /readme missing
Generate README /readme generate packages/validators
Validate links /readme links
Fix inconsistencies /readme fix packages/api

Audit Workflow

Step 1: Discovery

Run the missing docs check first:

# Find packages without README.md
for pkg in packages/*/; do [ -f "$pkg/README.md" ] || echo "Missing: $pkg"; done

# Find packages without AGENTS.md
for pkg in packages/*/; do [ -f "$pkg/AGENTS.md" ] || echo "Missing: $pkg"; done

# Find apps without documentation
for app in apps/*/; do
  [ -f "$app/README.md" ] || echo "Missing README: $app"
  [ -f "$app/AGENTS.md" ] || echo "Missing AGENTS: $app"
done

Step 2: Consistency Check

For each existing README, verify:

Check How
Package name matches Compare # @repo/name with package.json#name
Exports documented Cross-reference package.json#exports with README sections
Commands exist Verify pnpm commands in README work
Links valid Check internal links resolve
API up-to-date Compare documented API with actual exports

Step 3: Content Analysis

Read existing READMEs to extract patterns. Reference references/templates.md for standard sections.

Step 4: Report Generation

Output findings as:

## README Audit Report

### Missing Documentation
- [ ] `packages/validators` - No README.md
- [ ] `packages/analytics` - No README.md

### Outdated Documentation
- [ ] `packages/api/README.md` - Missing router: `ideas`
- [ ] `packages/logger/README.md` - Undocumented export: `sanitize.headers()`

### Broken Links
- [ ] `packages/database/README.md:45` - Link to non-existent ADR

### Format Issues
- [ ] `packages/config/README.md` - Missing "Usage" section

Read the full file on GitHub · 249 lines

Files

What ships with it

4 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. 11d ago First seen · 249 lines · 56 tokens per session scan A 3330d9baa5b2

Subscribe to this mod's changes

readme-maintenance is a skill published in the GitHub repository parisgroup-ai/imersao-ia-setup (1 stars, last pushed 29d ago), licensed MIT. It adds 56 tokens to every session and 1,794 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

surface-after-care

Regelmäßiger Pflegedurchlauf für ein bereits veröffentlichtes GitHub-Repository (Stufe 1, günstig und oft wiederholbar): zuerst alle Distributionsflächen des Projekts ermitteln (npm, PyPI, Registries, Marketplaces, Stores, Website) und Änderungen später dorthin spiegeln, dann Topics setzen, Privacy-Gate, Dokumente auf…

ellmos-ai/skills · 283 tokens

full-after-care

Tiefe Pflegerunde für ein veröffentlichtes GitHub-Repository (Stufe 2): enthält den vollständigen surface-after-care-Durchlauf und ergänzt ihn um drei teure Schritte — rechtliche Ersteinschätzung über die Law-Checker mit Wiedervorlage nach einem Jahr (Gutachten bleibt gitignored im Repo), Querverweise zu verwandten…

ellmos-ai/skills · 196 tokens

top-design

Create award-winning, immersive web experiences at the level of Awwwards-featured agencies. Use when the user mentions "Awwwards quality", "make my site stunning", "scroll animations", "parallax storytelling", "cinematic web design", "portfolio site", or "brand experience". Also trigger when elevating a standard…

wondelai/skills · 113 tokens

crossing-the-chasm

Navigate the technology adoption lifecycle from early adopters to mainstream market. Use when the user mentions "crossing the chasm", "beachhead segment", "whole product", "early adopters vs mainstream", "tech go-to-market", "bowling pin strategy", "technology adoption lifecycle", "pragmatist buyers", "growth stalled…

wondelai/skills · 139 tokens

design-everyday-things

Apply foundational design principles: affordances, signifiers, constraints, feedback, and conceptual models. Use when the user mentions "why is this confusing", "affordance", "error prevention", "discoverability", "human-centered design", "mental model", "mapping", "seven stages of action", "users keep making…

wondelai/skills · 132 tokens

web-typography

Select, pair, and implement typefaces for web projects. Use when the user mentions "font pairing", "which typeface", "line height", "responsive typography", "web font loading", "type hierarchy", "variable fonts", "FOUT/FOIT", "typographic scale", or "the text is hard to read". Also trigger when choosing between system…

wondelai/skills · 128 tokens