What are its main capabilities?

Key capabilities include automated `CLAUDE.md` and `README.md` generation from codebase analysis, context file synchronization, support for dry runs to preview changes, and options to preserve existing content while fixing inaccuracies.

What does the Markdown Documentation skill do?

It automates the creation, updating, and verification of project documentation files. It analyzes your codebase to generate accurate READMEs, `CLAUDE.md` context files, and `AGENTS.md` instructions, ensuring they always match your project's current state.

When should I use this skill?

Use this skill when you need to initialize a new project's documentation (`init context`), update an existing `README.md`, or synchronize your `CLAUDE.md` and `AGENTS.md` context files with recent code changes.

How does this skill improve my workflow?

It saves significant time by automating tedious documentation tasks. By verifying content against the actual codebase, it eliminates outdated information and ensures consistency, allowing you and Claude to work from a reliable source of truth.

Markdown Documentation

Name: Markdown Documentation
Author: PaulRBerg

byPaulRBerg

•

Learning & Documentation

Manages and automates the creation, verification, and updating of project documentation files like READMEs and context guides.

Automates the management of essential project documentation, including context files (CLAUDE.md), agent instructions (AGENTS.md), and READMEs. This skill ensures that documentation is always synchronized with the actual state of the codebase by analyzing file structures, package configurations, and build scripts. It emphasizes verification over blind generation, providing workflows to initialize documentation for new projects, update existing files with accurate information, and maintain a terse, expert-to-expert writing style. Use this skill to streamline documentation tasks and maintain high-quality, reliable project guides.

Key Features

01Enforces a terse, imperative, and expert-to-expert writing style for all generated content.

02Automated context file synchronization (CLAUDE.md, AGENTS.md) based on codebase analysis.

03Project context initialization for new or undocumented repositories.

04Standardized workflows with support for dry runs, preserving content, and varying levels of detail.

0558 GitHub stars

06README generation and updates using project metadata from files like package.json.

Use Cases

01Auditing and correcting discrepancies between existing documentation and the current codebase.

02Initializing CLAUDE.md and a README for a new project.

03Updating all project documentation after significant code changes or dependency updates.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add paulrberg/dot-claude md-docs

For use in Claude.ai and ChatGPT

Download Skill