documentation

Technical documentation doesn't have to be dull
Think about the kind of documentation you like to read, and write that. If people don't like it, you can be sure they'll let you know.
7 comments Posted 30 Aug 2016 by Ben Cotton Feed
Introduction to Read the Docs
Find out how Read the Docs aims to make documentation a little easier.
0 comments Posted 18 Aug 2016 by Ben Cotton Feed
3 easy steps to submitting a GitHub pull request
Your first pull request doesn't need to be a major one. Learn how to contribute to an open source project on GitHub in three easy steps.
2 comments Posted 2 Mar 2016 by Liran Tal Feed
Documentation should be concise, consistent, and simple
Three considerations and accompanying resources to keep in mind as you write documentation.
7 comments Posted 29 Feb 2016 by Ben Cotton Feed
Plerd: A Dropbox-friendly Markdown blog platform
Written in Perl, Plerd can be told to watch a Dropbox-synched directory with the plerdwatcher daemon, which will republish files as it sees changes.
1 comment Posted 22 Jan 2016 by D Ruth Bavousett Feed
Open in sky
Six non-code opportunities for contributing to open source software code and communities.
6 comments Posted 20 Jan 2016 by Safia Abdalla Feed
Typewriter keys
In this interview, Dru Lavigne explains how Sphinx is different from other open source solutions, and what kinds of projects should consider migrating their docs.  
1 comment Posted 18 Jan 2016 by Rikki Endsley (Red Hat) Feed
pink typewriter
We look at the 7 rules for writing world class technical documentation and which projects are getting it right.
4 comments Posted 11 Jan 2016 by Rikki Endsley (Red Hat) Feed
When I talk to college students who are working on their first open source projects, the message I emphasize over and over and (yes, one more time) over again is the importance of working openly. And yet, as I discovered myself while writing this post, working openly is harder than it sounds.
5 comments Posted 17 Dec 2015 by Gina Likins (Red Hat) Feed
typewriter keys
Learn how three tests can help you improve the readability of your documentation.
8 comments Posted 4 Nov 2015 by Laura Novich (Red Hat) Feed

Pages