crafting-effective-readmes

Topics in the source

• Crafting Effective READMEs
• Overview
• Process
• Step 1: Identify the Task
• Step 2: Task-Specific Questions
• Step 3: Always Ask
• Project Types
• Essential Sections (All Types)

READMEs answer questions your audience will have. Different audiences need different information - a contributor to an OSS project needs different context than future-you opening a config folder. Always ask: Who will read this, and what do they need to know? Ask: "What README task are you working on?" | Task | When | |------|------| | Creating | New project, no README yet | | Adding | Need to document something new | | Updating | Capabilities changed, content is stale | | Reviewing | Checking if README is still accurate | Creating initial README: 1. What type of project? (see Project Types below) 2. What problem does this solve in one sentence? 3. What's the quickest path to "it works"? 4. Anything notable to highlight? Adding a section: 1. What needs documenting? 2. Where should it go in the existing structure? 3. Who needs this info most? Updating existing content: 1. What changed? 2. Read current README, identify stale sections 3. Propose specific edits Reviewing/refreshing: 1. Read current README 2. Check against actual project state (package.json, main files, etc.) 3. Flag outdated sections 4. Update "Last reviewed" date if present After drafting, ask: "Anything else to highli

This is an excerpt. Refer to the complete source and its current requirements.