work_docs_readme-generator

Community

Auto-create a polished README from your project

AuthorJoNaYeon
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Reduces manual documentation effort by analyzing your project to generate a complete README.md.

Core Features & Use Cases

  • Project analysis: scans repository structure and common files to identify name, purpose, tech stack, and build/run commands.
  • Documentation output: produces sections for installation, usage, API references, examples, and contribution guidelines tailored to the project.
  • Quick customization: placeholders guide future edits and updates for evolving projects.

Quick Start

Run the skill on your project directory to generate a ready-to-use README.md.

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: work_docs_readme-generator
Download link: https://github.com/JoNaYeon/claude-code-skills/archive/main.zip#work-docs-readme-generator

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 471,000+ vetted skills library on demand.