The Vocabulary of GitHub for Documentation

Image credit: Flickr rob-sinclair

The Vocabulary of GitHub for Documentation

What if you could use GitHub, static site generators, and Continuous Integration and Deployment (CI/CD) for our documentation? I imagine you can track your backlog and get some metrics on the quality with their nice contributor graphs. I bet you could measure “docs drift” to figure out just how behind the docs have gotten. Hey, let’s also get access to the developer playground and fun equipment! Let’s play on the slides and swings while we make cool and beautiful documentation, side-by-side as collaborators.

I hope you’re wondering, “What would happen if we treated docs like code?”

Believe me, your fellow software builders are wondering, experimenting, or already starting down this road. I’ve seen this vision come to life and want to share my experiences so more people can learn these techniques.

git

I’ve found that the principles inherent to the social web for coding work extremely well for documentation. The social web, leads to social coding, leads to social documentation.

What is GitHub?

GitHub

Like many tools, git and GitHub were created by fire — through a pressing need for performant and efficient source control management for theLinux kernel. Read the history in the excellent Pro Git Book.

GitHub is the web interface for git the command-line tool, that works well on Linux, Mac, or Windows. To work with others on a project (code or docs), you merge files. This model is the opposite of using a “lock and checkout” model, where no one else can work on the piece at the same time as you. With GitHub, you can work separately and bring it all together later. Git has a non-linear branching model that can take some learning to get used to. That said, I’ve found git and GitHub for docs quite practical and even inspirational.

You can keep docs in a source code repository then the developers will review all your changes prior to merging them in. Unlike traditional source code management, branches are not full copies of entire code base so they are “cheap” and “fast.” The more Agile techniques are applied to documentation, the more treating docs like code makes sense.

GitHub definitions and parallels for information

I hope I’m talking to people who care a lot about words. Let’s start with some vocabulary and definitions to build upon.

  • Branch: Indicator of divergence from base without changing the main line (or “trunk” if you like to visualize organic tree-structures to remember this term).
  • Commit: Point-in-time snapshot of repository with changes.
  • Fork (noun): Copy of the repository that is entirely yours in your namespace. In GitHub-land, forking does not have a negative connotation that it can in other contexts (such as taking an open source project in a new direction in a huff to get different contributors). Rather, it is a way to contribute openly and publicly with your account attributed.
  • Fork (verb): Making a copy of the repository.
  • Issue: Defects, tasks, or feature requests.
  • Organization: Collection of group-owned repositories.
  • Pull Request: Comparison of edits to see if team wants to accept changes.
  • Push: Move changes branch-to-branch. When you type man git at a Terminal prompt to read the manual page for Git, you see “Update remote refs along with associated objects,” but that’s more technical than we need here.
  • Repository: Collection of stored code or documentation that is written and built like code.
  • Review: Do a line-by-line comparison of a change, much like an editor would for documentation, and comment on improvements or changes.

These definitions can give you decision points to make about information architecture, so think about which deliverables you’ll make, who should review and collaborate on those deliverables, and how you can automate publishing with the chunks of a repository or an organization as overarching collections.

Take a look at this article’s source on GitHub to get a sense of the “source” for a document. We’ll look at the source aspects in a future article. To stay in touch, subscribe to get relevant emails in your inbox.

You get three lessons plus a free review checklist in a neat PDF file.