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
Included in Course
  • 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 Front-End Web Developer Nanodegree Program.

Free Course

Writing READMEs

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

Icon steps

Course Leads

  • Walter Latimer
    Walter Latimer

    Instructor

What You Will Learn

Lesson 1

Writing READMEs

  • Learn what documentation is and who it's for.
  • Learn what parts make up a great README file.
  • Use Markdown to write a README file quickly and easily.
Lesson 1

Writing READMEs

  • Learn what documentation is and who it's for.
  • Learn what parts make up a great README file.
  • Use Markdown to write a README file quickly and easily.

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
Icon globe

Udacity 现已提供中文版本! A Udacity tem uma página em português para você! There's a local version of Udacity for you! Sprechen Sie Deutsch?

Besuchen Sie de.udacity.com und entdecken Sie lokale Angebote, unsere Partnerunternehmen und Udacitys deutschsprachigen Blog.

前往优达学城中文网站 Ir para a página brasileira Go to Indian Site Icon flag de Zu de.udacity.com continue in English