skills.rest
minfengyuan
minfengyuanCOMMUNITY
Explore all skills by this author →
GitHub

better-readme

Create evidence-grounded README drafts from repository files.

1|Updated Mar 27, 2026
Search Tags:#documentation#writing#onboarding#github#readme#repo-analysis
One-click install
npx skills add https://github.com/minfengyuan/harness-knowledge-base --skill better-readme
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: better-readme
Source: https://github.com/minfengyuan/harness-knowledge-base/tree/main/skills/better-readme
Command: npx skills add https://github.com/minfengyuan/harness-knowledge-base --skill better-readme

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about better-readme

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a README from existing repository files?▼

You draft a README by extracting verifiable facts from manifests, CI configs, examples, and license files to produce a Markdown landing page. The skill only prompts for missing product details like value proposition and target user.

What makes an evidence-grounded README draft better than a template?▼

An evidence-grounded README draft replaces generic template noise by extracting real install, run, and test instructions from manifests and CI configs. It avoids inventing claims and chooses archetype-aware sections for libraries, CLIs, or services.

Can I use this for a CLI tool or library repository on GitHub?▼

Yes, you can use this for CLI tools, libraries, or services on GitHub. The skill applies archetype-aware structuring to choose appropriate README sections based on repository type and omits unsupported template noise.

How do I update an outdated GitHub README without writing marketing copy?▼

To update an outdated GitHub README without marketing copy, the skill grounds new content in verifiable repository evidence from tests and manifests. It prompts only for missing factual gaps like maturity and value proposition instead of speculative text.

What should I do if my repository is missing manifest and CI files for README generation?▼

If your repository is missing manifest and CI files for README generation, the skill identifies these factual gaps and prompts you directly for the missing product details. It avoids inventing claims and outputs a single Markdown draft based on available evidence.

Related Skills

Explore More Content & Communication Skills→
nholder88nholder88
2

draft-repo-readme

Draft a README from a repository's source files and commit history.

Community
Intermediate
n-marusovn-marusov

aif-docs

Generate, maintain, and review project documentation from configuration files.

Community
Advanced
vuralserhat86vuralserhat86
43

quality_validator

Validate deliverables against quality standards and compliance requirements before shipping.

Community
Advanced
ashley-eyekyamashley-eyekyam
1

mine-incident-investigation

Investigate DGMS-reportable mining incidents with de-identified ICAM root cause analysis.

Community
Advanced