Skills
.Work. You
Rest

md-docs

Community

Automate doc updates to reflect code reality.

Content & Communication#documentation#markdown#CLAUDE.md#AGENTS.md#CONTRIBUTING.md#update-readme
AuthorPaulRBerg
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This skill helps keep project documentation synchronized with the actual codebase by updating README.md, CLAUDE.md, AGENTS.md, and CONTRIBUTING.md. It reduces drift between documentation and the codebase and minimizes manual editing.

Core Features & Use Cases

  • Detects repository structure, tooling, and workflows from package manifests and config files to generate precise, non-destructive updates.
  • Reads existing context files and applies targeted changes to align with code changes while preserving user-authored sections when requested.
  • Creates backups, provides diff previews (including dry-run mode), and logs what was updated for traceability.

Use cases:

  • Initialize documentation for new projects and maintainers
  • Update context files after refactors or dependency upgrades
  • Audit and correct inconsistencies between code and docs

Quick Start

Use the md-docs skill to update README.md, CLAUDE.md, AGENTS.md, or CONTRIBUTING.md. Start with a dry-run to preview changes: /md-docs:update-readme --dry-run

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: md-docs
Download link: https://github.com/PaulRBerg/agent-skills/archive/main.zip#md-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.