Tags: documentation


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

Tools and Practices for Documenting Microservices

I will assume you are at least familiar with the concept of microservices — loosely coupled services that provide discrete solutions to business use cases that you can combine to solve current needs and demand. The architectural pattern has gained popularity over the past years, and although not...
Read 0 Comments

Modular Documentation: How to Make Both Writers and Users Happy

Modular documentation is not a new concept. Writing documentation in modules that can be combined and reused has been around, in various incarnations, for many years, and it has many proponents as well as detractors. This article introduces a lightweight approach to documentation modularity. The...
Read 0 Comments

The Ten Essentials for Good API Documentation

API documentation is the number one reference for anyone implementing your API, and it can profoundly influence the developer experience. Because it describes what services an application programming interface offers and how to use those services, your documentation will inevitably create an...
Read 0 Comments

How to Write Documentation That's Actually Useful

Now more than ever we need well-documented code. Here are four ways to make sure your applications make sense to humans as well as to computers. Programmers love to write code, but they hate to write documentation. Developers always want to read documentation when they inherit a project, but...
Read 0 Comments

18 Open Source Translation Tools to Localize Your Project

Localization plays a central role in the ability to customize an open source project to suit the needs of users around the world. Besides coding, language translation is one of the main ways people around the world contribute to and engage with open source projects. There are tools specific to the...
Read 0 Comments

Real Paths Toward Agile Documentation

In a nutshell, documentation is deemed uncool and old school. Especially on flat agile teams, there’s a lack of ownership of who’s in charge of docs. And, even worse than testing, software documentation is the biggest hot potato in the software development lifecycle. Nobody wants to take...
Read 0 Comments

Open Source Survey

The Open Source Survey is an open data project by GitHub and collaborators from academia, industry, and the broader open source community. With over 50 questions, the 2017 survey covers a wide range of topics. Below, we highlight some of the most actionable and important insights about the...
Read 1 Comments

So You Want to Onboard a DevOps/WebOps Engineer/Consultant

At the moment everyone seems to be so concerned with recruiting DevOps Engineers but I feel the process of on-boarding them is still very hit and miss especially in busy organisations. Making it easy to get work done from day one Reduce the time spent learning the peculiarities of certain...
Read 0 Comments

Things I Learned Managing Site Reliability for Some of the World’s Busiest Gambling Sites

For several years I managed the 3rd line site reliability operation for many of the world’s busiest gambling sites, working for a little-known company that built and ran the core backend online software for several businesses that each at peak could take tens of millions of pounds in revenue per...
Read 0 Comments


Click Here!