README exists and describes the project
Why it matters
A missing or skeletal README is the single most common reason developers abandon a project within the first five minutes. Without a clear statement of what the project does and who it is for, every potential contributor, integrator, or evaluator must read source code to answer the most basic questions. iso-25010:2011 analysability directly penalizes this: a project that cannot be understood without reading its implementation is expensive to maintain and impossible to evaluate. Vibe-coded projects routinely ship with boilerplate placeholders — 'TODO: Add description' or 'This project was bootstrapped with create-next-app' — that communicate nothing.
Severity rationale
Critical because a project with no meaningful README cannot be evaluated, adopted, or safely integrated by any external developer, making the entire codebase effectively undiscoverable regardless of its technical quality.
Remediation
Replace the placeholder or missing README with one that answers three questions in the first 200 words: what does this project do, who is it for, and what problem does it solve. A minimal structure that passes:
# Project Name
One sentence: what this does and why it exists.
## Features
- Feature 1: brief explanation
- Feature 2: brief explanation
## Quick Start
npm install your-package-name
The description must appear in the first two paragraphs, use plain language, and not simply repeat the project name.
DetectionPro
The detection method for this pattern is part of AuditBuffet Pro.
The full method (what to look for, pass and fail conditions, and how results get reported) ships inside the Developer Documentation Audit. The pattern definition, severity rationale, and remediation remain openly licensed under CC-BY-4.0.
External references
- iso-25010:2011 · maintainability.analysability — Analysability — degree to which the product can be assessed for deficiencies or parts to be modified
Taxons
History
- 2026-04-18·v1.0.0·Initial import from developer-documentation·automated