skills.rest
fieldsphere
fieldsphereOFFICIAL
Explore all skills by this author →
GitHub

readme-hygiene

Detect code changes that invalidate README content and prompt documentation updates.

37|20|Updated Mar 2, 2026
Search Tags:#documentation#readme#hygiene#update#change-management#developer-docs
One-click install
npx skills add https://github.com/fieldsphere/cursor-team-marketplace-template --skill readme-hygiene
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-hygiene
Source: https://github.com/fieldsphere/cursor-team-marketplace-template/tree/main/plugins/technical-writing/skills/readme-hygiene
Command: npx skills add https://github.com/fieldsphere/cursor-team-marketplace-template --skill readme-hygiene

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

README hygiene helps ensure documentation stays accurate after code changes by prompting teams to update root and package READMEs when setup, usage, or developer workflows are affected.

Core Features & Use Cases

  • Detects mismatches between code changes and documented steps, installation, or usage.
  • Suggests nearest relevant README updates and can draft change notes for release docs.
  • Use Case: when a function is added or a command changes, run hygiene to surface missing docs or outdated instructions.

Quick Start

Run the hygiene check on your next code change to prompt updates to the nearest README.

Frequently Asked Questions about readme-hygiene

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep my README updated when code changes occur?▼

This Skill prompts README updates by detecting mismatches between code changes and documented setup, installation, or usage steps, then surfacing draft changes for the nearest relevant README.

What is README hygiene and why do I need it for developer docs?▼

README hygiene enforces documentation accuracy by detecting when code changes invalidate documented workflows. It prompts timely updates to root and package READMEs so developer docs stay accurate.

How do I detect outdated installation steps after modifying a codebase?▼

Run a hygiene check on your modified codebase to detect outdated installation steps. The check identifies invalidated setup instructions and surfaces missing docs or outdated commands for review.

Can I draft change notes for release documentation using this approach?▼

Yes, you can draft change notes for release documentation. When a function is added or a command changes, the hygiene check surfaces missing docs and suggests draft updates for review.

Does this documentation update process work across multiple package READMEs?▼

Yes, the process works across multiple package READMEs. It enforces that the nearest relevant README is updated whenever setup, usage, or developer workflows are affected by codebase changes.

Related Skills

Explore More Content & Communication Skills→
alirezarezvanialirezarezvani
763

readme-updater

Automate README updates by parsing diffs and detecting relevant code changes.

Community
Basic
monomono
5.5k

release-publish

Publish SkiaSharp packages to NuGet.org and finalize releases.

Official
Advanced
matthiaskloftmatthiaskloft

ship

Commit code, create a pull request, and monitor CI status for merging.

Community
Advanced
masrurimzmasrurimz

doc-writer

Generate JSDoc/TSDoc comments, READMEs, and API documentation across codebases.

Community
Basic