Writing READMEs
via Udacity
- Provider Udacity
- Cost Free Online Course
- Session Self Paced
- Language English
- Learn more about MOOCs
Taken this course? Share your experience with other students. Write review
Overview
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.
Why Take This Course?
If you've ever written code or needed to examine somebody else's code, you know how challenging it can be to try to make sense of a new codebase without any context.
This course will show you how to make your code more approachable to the humans who will ultimately need to make meaning of your code.
Syllabus
This course is split into three short stages:
- What is documentation, and who is it for?
- What makes a good README?
- How can you write a README quickly using Markdown?
Taught by
Tags
Help Center
Most commonly asked questions about Udacity
Reviews for Udacity's Writing READMEs Based on 2 reviews
- 5 star 0%
- 4 star 0%
- 3 star 50%
- 2 star 50%
- 1 star 0%
Did you take this course? Share your experience with other students.
Write a review- 1
- 1
Never Stop Learning!
