DEV Community

loading...
Cover image for Better readme in 5 minutes. (Snack Pack #1)

Better readme in 5 minutes. (Snack Pack #1)

Blake Campbell
Always improving as a developer. Powered by coffee.
・1 min read

Documentation is an easy win

Readmes are often overlooked, abandoned, or forgotten entirely. Don't let a pour readme sour a good project.

A good readme is easy. First off this is just a starting point, there's always room to improve a readme. Here's how I start all my projects.

- Project Details 
  - Who is the project for? 
  - What does it do?
- Set up
  - How can I get someone up and running on this project? 
- Tech behind the project.
  - What frameworks/technologies are we using?
- Architecture 
  - How is the folder structure laid out? Just big picture stuff
- Testing / Formatting
  - Do you have formatting or testing and how is it enforced?
- FAQs
  - What's confusing about this project and why?
Enter fullscreen mode Exit fullscreen mode

My template for new Readmes:

https://gist.github.com/BlakeCampbells/58b72751eae87f6891d0fc357298e299

Additional Resources

https://gist.github.com/PurpleBooth/109311bb0361f32d87a2
https://github.com/RichardLitt/standard-readme

My snack pack reads are intended for a quick read without any fluff or BS.

Feedback is always welcome.

Discussion (2)

Collapse
dkoczka profile image
David Koczka

This is a great template. Thank you for sharing!

Collapse
nikhilmwarrier profile image
Nikhil M Warrier

Awesome! I will start using it myself from now on. Thanks for sharing!