search

thegooddocsproject / templates

Templates created by The Good Docs Project - for all your tech writing needs.
https://thegooddocsproject.dev/
Other
673 stars 169 forks source link

README template #177

Open barbaricyawps opened 3 years ago

barbaricyawps commented 3 years ago

Template description

Provide a template for writing an effective project README file.

Benefits

This is a minimum viable docset for any new open source project. We should research best practices and provide guidance.

Sub-tasks

  1. Create readme-template.md and write content for it. You may or may not want to re-use content from the files already in the folder
  2. Create readme-guide.md and write content for it Create readme-theory.md and write content for it. This is any research and conclusions about best practices that support what you are presenting to the end user in the other files. This can be an empty stub file.

Use cases

Every new project needs a viable README file.

Additional information

To be added later

aidanatwork commented 3 years ago

@barbaricyawps I added some labels to this since the README is included in our P1 templates: https://docs.google.com/document/d/1qCqNIdSz_EM37LjNBfLiVdaNCkEuyTfF_RNahA2aLik/edit?pli=1#