Tags: documentation

The State of Docker Container Documentation

We need to confront container documentation as the crucial, non-trivial problem that it is. TL;DR — As far as I can tell, there’s currently no way of providing documentation for specific containers that we could fairly call canonical, “best practice,” or even all that widely used. This blog post...
Read 0 Comments

The Beginner’s Guide to Contributing to Open Source Projects

The practice of building and maintaining open source software works because people from all over the world, of all abilities and backgrounds, form communities to support the projects they care about. It’s not difficult to support the open source projects you use every day, and the efforts you make...
Read 0 Comments

clark-tibbs-367075-unsplash.jpg

Kubernetes
The Non-Code Contributor’s Guide aims to make it easy for anyone to contribute to the Kubernetes project in a way that makes sense for them.

Introducing the Non-Code Contributor’s Guide

It was May 2018 in Copenhagen, and the Kubernetes community was enjoying the contributor summit at KubeCon/CloudNativeCon, complete with the first run of the New Contributor Workshop. As a time of tremendous collaboration between contributors, the topics covered ranged from signing the CLA to deep...
Read 0 Comments

The Eight Rules of Good Documentation

If useful documentation is so important to the success of projects and developer well-being, why don't all projects have it? The answer, I believe, is that like good code, good documentation is difficult and time consuming to write. In my eyes, there are eight rules that we can follow to produce...
Read 0 Comments

typewriter-801921_1920.jpg

documentation
Writing in English for an international audience takes work; here are some handy tips to remember.

5 Tips to Improve Technical Writing for an International Audience

Learn how to write for an international audience in this article from our archives. Writing in English for an international audience does not necessarily put native English speakers in a better position. On the contrary, they tend to forget that the document's language might not be the first...
Read 2 Comments

Manual Work Is a Bug: Always Be Automating

Let me tell you about two systems administrators I know. Both were overloaded, busy IT engineers. Both had many repetitive tasks to do. Both wanted to automate these tasks. After observing these two people for a year, I noticed that one made a lot of progress, while the other one didn't. It wasn't...
Read 0 Comments

RTFM? How to Write a Manual Worth Reading

There's common wisdom in the open source world: Everybody knows that the documentation is awful, that nobody wants to write it, and that this is just the way things are. But the truth is that there are lots of people who want to write the docs. We just make it too hard for them to participate. So...
Read 0 Comments

Secrets of Writing Good Documentation

Taylor Barnett, a Community Engineer at Keen IO, says practice and constant iteration are key to writing good documentation.  At the upcoming API Strategy & Practice Conference 2017, Oct. 31 -Nov. 2 in Portland, OR, Barnett will explain the different types of docs and describe some best...
Read 0 Comments

Top 5 Linux Pain Points in 2017

As I discussed in my 2016 Open Source Yearbook article on troubleshooting tips for the 5 most common Linux issues, Linux installs and operates as expected for most users, but some inevitably run into problems. How have things changed over the past year in this regard? Once again, I posted the...
Read 0 Comments

os-tools.jpg

open source guides
The Tools for Managing Open Source Programs guide provides an exhaustive collection of categorized tools that any open source program can benefit from.

Tools for Managing Open Source Programs: A Free Guide

Is your organization looking to build out an open source program? If so, you’re not alone, but not every organization has a holistic sense of the available tools that can help create a healthy program. A simple charter document and a few spreadsheets for tracking projects won’t cut it anymore in...
Read 1 Comments

Pages

Click Here!