readme-standards

Official

Set the standard for clean, consistent docs.

Authorzerobias-org
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Validate README templates to ensure consistent documentation quality across projects.

Core Features & Use Cases

  • Enforces a YAML frontmatter with name and description
  • Checks for required sections: Installation, Usage, Authentication, Operations, Examples, Testing
  • Provides a Quick Start directive in plain language

Quick Start

Run the README template validator to ensure your README adheres to the standard sections and quality guidelines.

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-standards
Download link: https://github.com/zerobias-org/module/archive/main.zip#readme-standards

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.