Skills
.Work. You
Rest

readme-writer

Official

Create clear, consistent READMEs for modules.

Content & Communication#documentation#readme#structure#guidelines#module#developer
AuthorAztecProtocol
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This guide helps developers produce clear, consistent READMEs for modules, packages, or subsystems so others can understand purpose, usage, and interdependencies without digging into code.

Core Features & Use Cases

  • Placement guidelines: README should live next to the module it documents.
  • Structure templates: Use a standard layout with Overview, Usage, API, and Examples.
  • Quality guidance: Emphasize purpose, input/output, and real-world examples to reduce onboarding time.

Quick Start

Create a README.md next to the target module, include YAML frontmatter with name and description, then add sections for overview, usage, and examples. Provide at least one concrete example and keep the language concise and developer-focused.

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: readme-writer
Download link: https://github.com/AztecProtocol/aztec-packages/archive/main.zip#readme-writer

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