Writing READMEs

Need help getting started?


  1. Course Resources
    • Additional Reading
    • External Resources
  2. Course Syllabus
    • Course Structure
  3. Acknowledgements

Course Resources

Additional Reading

The following documentation resources are mentioned in this course:

External Resources

Course Syllabus

In this course, you’ll learn what documentation is and why it’s an important part of the development process. You'll learn how to build a well-structured README that you’ll be able to incorporate into your projects moving forward. By the end of this course, you will have written your very own README file using Markdown.

Course Structure

This course is split into three short stages:

  1. What is documentation, and who is it for?
  2. What makes a good README?
  3. How can you write a README quickly using Markdown?


We'd like to thank instructor Walter Latimer, contributors Nija - DevOps Engineer, Art - Director of Engineering, and the rest of the Udacity team for all their help in putting this course together.