doc-maintainer

Update and validate README.md, CLAUDE.md, and code comments.

1|Updated Nov 2, 2025
One-click install
npx skills add https://github.com/fubira/claude-code-settings --skill doc-maintainer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-maintainer
Source: https://github.com/fubira/claude-code-settings/tree/main/skills/doc-maintainer
Command: npx skills add https://github.com/fubira/claude-code-settings --skill doc-maintainer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintains concise, accurate, project-aligned documentation. Creates, updates, and validates README.md, CLAUDE.md, code comments, and other documentation to prevent drift.

Core Features & Use Cases

  • Validate and update README.md, CLAUDE.md, and code comments
  • Enforce CLAUDE.md and README standards
  • Ensure documentation consistency across the project

Quick Start

Request a documentation update: "Update README.md to reflect current setup" or "Validate CLAUDE.md alignment."

Frequently Asked Questions about doc-maintainer

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

FAQPage Schema
How do I keep my README.md and project documentation up to date?

README.md maintenance prevents documentation drift by enforcing concise structure (≤150 lines), scannable formatting, and alignment with current project setup. This Skill validates and updates README.md, CLAUDE.md, and code comments to reflect actual implementation, catching outdated information during feature work or on explicit request.

What documentation standards should I enforce across my project?

Documentation standards include language-specific conventions—Go public doc comments, TypeScript JSDoc—plus project-level rules for README.md, CLAUDE.md, and inline comments. This Skill validates these standards and updates docs to enforce consistency, removing redundancy and temporal information while keeping content scannable.

Can I automate code comment validation alongside README updates?

Yes. This Skill validates and updates documentation across README.md, CLAUDE.md, setup guides, and code comments in a single pass, applying language-specific standards (JSDoc, Go doc comments) and markdownlint rules to catch alignment issues before they compound.

How do I prevent documentation from becoming stale during development?

Documentation drift happens when code changes outpace docs. This Skill integrates into feature implementation to validate CLAUDE.md and README.md against current code, flagging mismatches through IDE diagnostics so you update docs as you ship features, not months later.

What's the best way to structure a README for scannability and brevity?

Effective README structure keeps content under 150 lines, uses clear sections for quick scanning, removes temporal markers (dates, version numbers), and eliminates redundancy. This Skill validates and refactors README.md to meet these standards while preserving essential setup and usage information.