About this Course

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 Cost
Free
Timeline
Approx. 3 days
Skill Level
beginner
Get Certified Now

View the Nanodegree

Included in Product

Rich Learning Content

Interactive Quizzes

Taught by Industry Pros

Self-Paced Learning

Student Support Community

Join the Path to Greatness

This free course is your first step towards a new career with the Intro to Programming Nanodegree Program.

Free Course

Writing READMEs

by

Enhance your skill set and boost your hirability through innovative, independent learning.

Icon steps 54aa753742d05d598baf005f2bb1b5bb6339a7d544b84089a1eee6acd5a8543d
 
 

Course Leads

Walter Latimer
Walter Latimer

Instructor

Prerequisites and Requirements

This course is for anybody who writes code or works with others who do. The only prerequisites are:

  • A basic understanding of HTML
  • A basic understanding of git and GitHub (helpful, but not required!)

See the Technology Requirements for using Udacity.

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.

What do I get?
Instructor videos Learn by doing exercises Taught by industry professionals