Skills
.Work. You
Rest

better-readme

Community

Turn repo evidence into a clear README

Content & Communication#documentation#writing#onboarding#github#readme#repo-analysis
Authorminfengyuan
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Create a focused, accurate README for a repository when the existing landing page is missing, generic, or out of date by grounding the draft in verifiable repository evidence and avoiding invented claims.

Core Features & Use Cases

  • Evidence-first drafting: Extracts facts from manifests, examples, CI configs, tests, and license files to support install, run, and test instructions.
  • Minimal, targeted questions: Prompts only for missing product facts (value proposition, target user, maturity) instead of speculative marketing copy.
  • Archetype-aware structure: Chooses appropriate sections for libraries, CLIs, services, or developer tooling and omits unsupported or template noise.
  • Use case: Turn a weak template README into a concise GitHub landing page that includes a one-line value prop, quick start, real usage examples, and license/contributing notes based on repo signals.

Quick Start

Ask the assistant to draft a complete README for this repository using its files and then list any missing factual gaps needed to finalize the draft.

Dependency Matrix

Required Modules

None required

Components

references

💻 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: better-readme
Download link: https://github.com/minfengyuan/harness-knowledge-base/archive/main.zip#better-readme

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.