mverab

Docs Readme — Documentation skill for Claude Code

Documentation community

Generate a README.md for the current project.

How to install Docs Readme

Installs to ~/.claude/commands/mverab-claude-beyond-code-docs-readme.md

Terminal
mkdir -p ~/.claude/commands && curl -fsSL https://raw.githubusercontent.com/mverab/claude-beyond-code/HEAD/.claude/commands/docs-readme.md -o ~/.claude/commands/mverab-claude-beyond-code-docs-readme.md

Restart Claude Code, or start a new session, for it to be picked up.

What Docs Readme does

name: docs:readme description: Generate a README.md for the current project. prompt: | Analyze the files in the current directory and generate a comprehensive README.md file. The README should include:

  • A project title and a brief description of its purpose.
  • A "Getting Started" section with installation and usage instructions.
  • A description of the main features or components.
  • Any other relevant information you can infer from the code.

Create the file named `README.md` i

Alternatives in Documentation

  • Doc Co-authoring — Guide users through structured workflow for co-authoring documentation 94.1k ★
  • OpenAI Docs — Provide authoritative guidance from OpenAI developer documentation 14.6k ★
  • Documentation Sync — Check if documentation matches the current code state 5.8k ★

Full documentation available on GitHub

View Source Repository

Related Skills

Arc42 — Documentation skill for Claude Code

Arc42

Generate or update arc42 architecture documentation with C4 diagrams for the current project. Reads the codeba

Documentation community
Update Docs — Documentation skill for Claude Code

Update Docs

by Consiliency - Reviews current documentation status, updates implementation progress, reviews phase document

Documentation community
Ccc Docs — Documentation skill for Claude Code

Ccc Docs

Look up current documentation for a library or topic via Context7.

Documentation community
Validate Docs — Documentation skill for Claude Code

Validate Docs

Validate that site and README documentation is current. Report-only — flags issues without modifying anything.

Documentation community
Release Docs — Documentation skill for Claude Code

Release Docs

Build and update the documentation site with current plugin components

Documentation community
Save — Documentation skill for Claude Code

Save

Save the current conversation or a specific insight into the wiki vault as a structured note.

Documentation community

Related Agents

Docs Checker — Development agent for Claude Code

Docs Checker

Use this agent when you need to verify that documentation in /docs accurately reflects the current behavior an

Development community
Memory Recalibrator — Development agent for Claude Code

Memory Recalibrator

Memory recalibration agent. Periodically scans forensics docs and memory entries for staleness signals, re-ver

Development community
Azure Architect — DevOps & Infrastructure agent for Claude Code

Azure Architect

Expert Azure architecture guidance grounded in the Well-Architected Framework and current Microsoft docs. Use

DevOps & Infrastructure community