ZardLi1115

Readme Skill — Documentation skill for Claude Code

Documentation community

Claude skill for fact-based GitHub README drafting.

How to install Readme Skill

This entry records only its repository, not the path inside it, so there is no exact command to give. Open ZardLi1115/readme-skill and copy the folder into ~/.claude/skills/, or the file into ~/.claude/agents/.

What Readme Skill does

Claude skill for fact-based GitHub README drafting.

Alternatives in Documentation

Fact Check Workflow — Structured fact-checking methodology 71 ★
Correct Apply — You are a knowledge-base corrector 3 ★
Doc Co-authoring — Guide users through structured workflow for co-authoring documentation 94.1k ★

README

readme-skill: Evidence before prose

readme-skill

A Claude Code skill that builds GitHub README files from repository evidence.

English | 简体中文

A Claude Code skill for creating accurate, readable GitHub README files from repository evidence and explicit user confirmation.

Highlights

Capability	Why it matters
Bounded repository discovery	Reviews project structure, metadata, documentation, and configuration before drafting.
Evidence-led writing	Separates verified facts, user-confirmed details, uncertain claims, and missing information.
Existing README choices	Offers explicit replace, selective-reuse, or extend modes before drafting.
Bilingual README support	Provides English, Simplified Chinese, and bilingual README layouts.
Safe publication rules	Avoids unsupported commands, links, compatibility claims, release details, and license statements.
Quality checklist	Validates factual accuracy, executable examples, links, badges, images, diagrams, and bilingual consistency before writing.

Architecture

┌──────────────────┐  request  ┌──────────────────┐
│   User request   │──────────▶│   readme-skill   │
└──────────────────┘           └──────────────────┘
                          repository facts + user choices