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.
Overview
Syllabus
- 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.
Taught by
Walter Latimer
Charts
- #2 in Subjects / Grammar & Writing / Technical Writing
Tags
Related Courses
Related articles
Reviews
2.5 rating, based on 2 Class Central reviews
-
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.
