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
  • Icon course 01 3edf6b45629a2e8f1b490e1fb1516899e98b3b30db721466e83b1a1c16e237b1 Rich Learning Content

  • Icon course 04 2edd94a12ef9e5f0ebe04f6c9f6ae2c89e5efba5fd0b703c60f65837f8b54430 Interactive Quizzes

  • Icon course 02 2d90171a3a467a7d4613c7c615f15093d7402c66f2cf9a5ab4bcf11a4958aa33 Taught by Industry Pros

  • Icon course 05 237542f88ede3178ac4845d4bebf431ddd36d9c3c35aedfbd92e148c1c7361c6 Self-Paced Learning

  • Icon course 03 142f0532acf4fa030d680f5cb3babed8007e9ac853d0a3bf731fa30a7869db3a 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 54aa753742d05d598baf005f2bb1b5bb6339a7d544b84089a1eee6acd5a8543d

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

Thanks for your interest!

We'll be in touch soon.

Icon globe e82eae5d45465aba4fbe4bb746905ce55dc3324f310b79c60e4a20089057d347

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 deedb1a7a695700236cb6ef4204ddbede5d197dab9b47716c87a0b4d5d9fc325 Zu de.udacity.com continue in English