Online Course
Writing READMEs
via Udacity
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
Walter Latimer
Tags
Related Courses
-
Academic English: Writing
University of California, Irvine
1.5 -
Business Writing
University of Colorado Boulder
3.8 -
Technical Writing
Moscow Institute of Physics and Technology
5.0 -
Interviewing and Resume Writing in English
University of Maryland, College Park
-
Getting Started with Essay Writing
University of California, Irvine
4.3 -
Programming for Everybody (Getting Started with Python)
University of Michigan
4.9
Reviews
2.5 rating, based on 2 reviews
-
Panashe M Fundira
Panashe M Fundira 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! -
Colin Khein completed this course.
Never Stop Learning!
