Practice & Assessment
Test your understanding of Writing Great README Files
Multiple Choice Questions
6A README starts with: 'This is a powerful, blazing-fast, modern caching solution with TTL, LRU eviction, Redis support, and more.' What is the primary problem?
What is the purpose of a verification step at the end of installation instructions?
Where should badges appear in a README and why?
A usage example shows code but no output. What is the documentation problem?
What is the recommended maximum number of badges in a README before they become noise?
Which usage example approach follows the progressive disclosure principle correctly?
Coding Challenges
1Write a Complete README for a Fictional npm Package
You are given a JSON specification for a fictional npm package called 'envguard' — a CLI tool that validates environment variables against a schema file before app startup. Input: the spec describes 4 CLI flags, 2 config file formats, and 3 error output types. Task: write a complete README.md including title, one-paragraph description (no superlatives, outcome-focused), badges section (4 placeholder badges with correct Markdown syntax), prerequisites, installation with verification step, and a usage section with at least 3 progressive code examples showing real terminal output. Output: a single README.md file. Constraint: description must be under 60 words. Estimated time: 25–30 minutes.
Mini Project
README Rewrite Project
Find a real GitHub repository with a README that scores poorly on clarity, completeness, or structure. Rewrite the entire README applying all module concepts: outcome-focused description with no superlatives, badges with correct placement, complete installation instructions with prerequisites and a verification step, progressive usage examples with output, and a contributing section. Submit both the original and rewritten README with a 200-word diff analysis explaining every change you made and why.