Columns

Handy GitHub Resources

By Nicky Bleiel | STC Associate Fellow

bleielnickyThis column is a quick reference guide exploring “essential” technical communication topics. Please send questions or comments to Nicky Bleiel at nableiel@us.ibm.com. Follow her on Twitter: @nickybleiel.

GitHub is a Web-based service that hosts code and other content in Git repositories and provides version control, project management, and social features.

There are a variety of resources available to learn about GitHub, including quick reference guides, tutorials, videos, books, and webinars. Create a free GitHub account (https://help.github.com/categories/setup/) and take a look.

Learning GitHub

The GitHub Help is excellent. I recommend you read the GitHub Glossary before starting any tutorials to familiarize yourself with the terminology. The GitHub Guides are short (< 10 min) tutorials, and include a “Hello World” project—always a good place to start.

Mastering Markdown

The GitHub READMEs, comments, wikis, Gists, and more are written in Markdown, a lightweight markup language that can be converted to HTML easily.

Books
Projects of Interest

GitHub hosts many projects that may be of interest to technical communicators. For example:

Fun Stuff

The Octodex includes the original Octocat and variations created by the community. The Octocat is the official GitHub Mascot and was created by Simon Oxley, the same artist who created the original Twitter bird.

GitHub supports Emoji; the Emoji Cheat Sheet will introduce you to a variety of emoji you can use in your Readmes, comments, and more. The “Ship It Squirrel” (:shipit:) is used in GitHub comments to indicate that you believe a change is ready to ship. And where else can you read the Apollo 11 source code?

Add Comment

Click here to post a comment

Download the Mar/Apr 2020 PDF

2020 PDF Downloads

Ad

Ad

Ad