domains / families / documents / crafting-effective-readmes

crafting-effective-readmes

authentic

Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.

When to use

• Creating new READMEs
• Adding documentation sections
• Updating stale README content
• Reviewing README accuracy
• Writing Open Source READMEs
• Writing Personal READMEs
• Writing Internal READMEs
• Writing Config READMEs

When not to use

• Tasks not related to README files

Skill page

Source