armstrongl

Generate Readme — Documentation skill for Claude Code

Documentation community

Generates a comprehensive, professional README file for any repository, project, or subfolder following industry best practices and documentation psychology principles.

How to install Generate Readme

Installs to ~/.claude/skills/armstrongl-claude-toolbox-generate-readme/SKILL.md

Terminal
mkdir -p ~/.claude/skills/armstrongl-claude-toolbox-generate-readme && curl -fsSL https://raw.githubusercontent.com/armstrongl/claude-toolbox/HEAD/commands/generate-readme.md -o ~/.claude/skills/armstrongl-claude-toolbox-generate-readme/SKILL.md

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

What Generate Readme does

name: generate-readme description: Generates a comprehensive, professional README file for any repository, project, or subfolder following industry best practices and documentation psychology principles. argument-hint: [path] allowed-tools: Bash(git:*), Bash(npm:*), Bash(yarn:*), Bash(pip:*), Bash(cargo:*), Edit, Read, Write, MultiEdit, Grep, Glob, Task, WebFetch, WebSearch, LS thinking-mode: deep auto-execute: false parameters:

  • name: path type: string required: false default

Alternatives in Documentation

  • Doc Co-authoring — Guide users through structured workflow for co-authoring documentation 94.1k ★
  • Context7 — claude-plugins-official Up-to-date library documentation lookup 50.1k ★
  • Notion Research Documentation — Research Notion content and synthesize findings into structured briefs 14.6k ★

Full documentation available on GitHub

View Source Repository

Related Skills

Best Practices Researcher — Documentation skill for Claude Code

Best Practices Researcher

Research industry best practices for development

Documentation community
Diataxis Explanation — Documentation skill for Claude Code

Diataxis Explanation

Create understanding-oriented explanation documentation following the Diataxis framework

Documentation community
Diataxis Howto — Documentation skill for Claude Code

Diataxis Howto

Create task-oriented how-to guide documentation following the Diataxis framework

Documentation community
Attribution Notice — Documentation skill for Claude Code

Attribution Notice

This project includes documentation and content derived from the following sources under the CC-BY-4.0 license

Documentation community
Monthly Vulnerability Report — Documentation skill for Claude Code

Monthly Vulnerability Report

Generate a comprehensive vulnerability report for the month of <-MONTH YEAR-> in Markdown format with the foll

Documentation community
Video Default — Documentation skill for Claude Code

Video Default

Provide a comprehensive scene-by-scene breakdown of this video. Organize the analysis into a Markdown table wi

Documentation community

Related Agents

Conversion Optimizer — Content & Marketing agent for Claude Code

Conversion Optimizer

Conversion rate optimization specialist. Use for maximizing conversion rates across marketing assets by applyi

Content & Marketing community
Divergent Thinking — Development agent for Claude Code

Divergent Thinking

Nonlinear thinker — sees structural connections across domains that linear thinkers miss. Generates genuinely

Development community
Service Agent — Development agent for Claude Code

Service Agent

Creates well-structured Rails service objects following SOLID principles with callable interface and error han

Development community