Skills
.Work. You
Rest

readme-creation

Community

Create self-contained READMEs for onboarding

Content & Communication#template#documentation#onboarding#readme#directory-structure#non-recursive
AuthorKemingHe
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This skill generates self-contained READMEs that explain a directory's purpose, structure, and context, enabling instant onboarding without needing parent documentation.

Core Features & Use Cases

  • Create consistent, self-contained READMEs for new or updated directories
  • Emphasize quick orientation within 30 seconds and link to subdirectory READMEs
  • Document patterns for large directories to reduce maintenance

Quick Start

Tell your AI agent to create a README for [directory-path].

Dependency Matrix

Required Modules

None required

Components

assets

💻 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: readme-creation
Download link: https://github.com/KemingHe/common-devx/archive/main.zip#readme-creation

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.