crafting-effective-readmes

Templates and guidance for writing READMEs matched to your project type and audience. 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?" Creating initial README: Adding a section: Updating existing content: Reviewing/refreshing: After drafting, ask: "Anything else to highlight or include that I might have missed?" Ask the user if unclear. Don't assume OSS defaults for everything. Every README needs at minimum: - Identifies four project types (Open Source, Personal, Internal, Config) with distinct audience needs and required sections - Provides a structured three-step process: identify the task (creating, adding, updating, or reviewing), ask task-specific questions, then solicit final feedback - Includes essential baseline sections for all READMEs: name, description, and usage with examples - References supporting materials covering section checklists by project type, common prose mistakes, and deeper reference guidance - What type of project? (see Project Types below) - What problem does this solve in one sentence?