Get started with custom lists to organize and share courses.

Sign up

Class Central is learner-supported. When you buy through links on our site, we may earn an affiliate commission.

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:

  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?

Taught by

Walter Latimer

Help Center

Most commonly asked questions about Udacity Udacity

Reviews for Udacity's Writing READMEs
2.5 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
Panashe F
3.0 3 years ago
Panashe completed this course, spending 1 hours a week on it and found the course difficulty to be very easy.
This is a very basic overview of READMEs, why their useful, and how to write markdown. If you've used Github a lot, there likely won't be a whole lot of new material here. It is a good reminder of the importance of documentation though!
Was this review helpful to you? Yes
Colin K
2.0 4 years ago
by Colin completed this course.
0 person found
this review helpful
Was this review helpful to you? Yes
  • 1

Class Central

Get personalized course recommendations, track subjects and courses with reminders, and more.

Sign up for free

Never stop learning Never Stop Learning!

Get personalized course recommendations, track subjects and courses with reminders, and more.