5 tips for making documentation a priority in open source projects | Opensource.com

5 tips for making documentation a priority in open source projects

Documentation is as important as code, so make sure you treat it that way. Here's how.

Files in a folder
x

Subscribe now

Get the highlights in your inbox every week.

Open source software is now mainstream; long gone are the days when open source projects attracted developers alone. Nowadays, users across numerous industries are active consumers of open source software, and you can't expect everyone to know how to use the software just by reading the code.

Even for developers (including those with plenty of experience in other open source projects), good documentation serves as a valuable onboarding tool when people join a community. People who are interested in contributing to a project often start by working on documentation to get familiar with the project, the community, and the community workflow.

Common challenges with documentation in open source

Although everyone agrees that documentation is important and needs to be done, some of the ways we do it result in poor quality and lack of consistency across different parts of documentation in the project. For example, when developers are too focused on code, they don't start working on documentation until the last minute (e.g., right before the release). And all too often, documentation tasks are done by volunteers, people who have a hard time saying "no." To make things worse, people may forget about the documentation after the release, so they never change or improve it, and the vicious cycle repeats.

5 best practices

We have been involved in documentation in a number of open source projects at Linux Foundation Networking and GitLab over the past few years. Below, we're sharing some things we've learned that we hope will help make documentation a first-class citizen in your open source project.

  1. Value contributions to documentation just as much as code contributions: A lot of the focus in many open source communities tends to be on code. One easy way to make sure documentation contributions are valued by everyone is to give equal credit to documentation and code in your community metrics. It should not matter whether a commit, merge request, or pull request is for code or documentation. In addition, when you do community recognition, include key accomplishments by the people who contribute to documentation.

  2. Put documentation and code in the same project repo: We highly recommend that a project's code and documentation both reside in the same repository. (A good way is to make /doc or /docs a top-level directory in the repository.) For one, this makes documentation easy for anyone to find. More importantly, your documentation will be on equal footing as code and other project resources when everything is in the same repository.

  3. Make documentation a requirement for a merge or release milestone: If your project has a lengthy release cycle (e.g., three to six months or more), we highly recommend having interim checkpoints for documentation (like this example from the ONAP community). This ensures documentation work is not put off until right before the release, and instead, everyone works on documentation throughout the release cycle. If it's feasible for your community, you could make documentation a required step for all code contributions that will impact users (see this example from GitLab).

  4. Have a consistent contribution process for code and documentation: We also recommend having a consistent contribution process and using the same toolchains for code and documentation. As we noted earlier, many new community members start contributing by working on documentation, as you often don't need deep technical knowledge of the software to get started. It's good for new contributors to onboard in the community by getting familiar with the contribution workflow and meeting other community members. If these new contributors later want to get involved in other parts of the project (including code), you want the toolchains and contribution process to be familiar. Otherwise, they will need to go through another onboarding process, which creates an unnecessary hurdle for contributors. If your code and documentation have different contribution processes, you may risk creating an impression that documentation is less than a first-class citizen compared to code.

  5. Have well-documented processes for contributing to documentation: This may seem obvious, but it's easy to neglect. Since documentation is a good entry point for new contributors, you want to lower the barrier to entry as much as possible. Having good documentation on the contribution workflow, how to get started, where to find issues to work on, how to get help, and more will go a long way to helping new contributors feel welcome and get involved in your community.

What else?

Do you have other tips for making documentation a first-class citizen in open source communities? If so, please share them in the comments.


This article is based on Ensuring that documentation Is a first-class citizen in open source projects presented at Open Source Summit North America in June 2020. 

Typewriter with hands

Mixing experienced tech writers with open source communities reveals new approaches for creating better docs.
Abstract connections between dots

Learn about the importance of architecture and specifically about the importance of diagrams.

Topics

About the author

Ray Paik - Ray is a Community Manager at GitLab where he is helping to grow the community of contributors to GitLab. Prior to GitLab, Ray was responsible for the day-to-day operation of the Open Platform for NFV (OPNFV) community since its launch in 2014. He has over 15 years of experience in the high-tech industry in roles ranging from software engineer, product manager, program manager, account manager, and team lead at companies such as EDS, Intel, Linux Foundation, and Medallia. Ray lives in...

About the author

Sofia Wallin - As part of the Ericsson Software Technology (EST) organization, Sofia is involved in driving open source engagements, supporting in establishing the EST business and act as an advocate for open source throughout Ericsson. She is the technical lead for documentation within Linux Foundation Networking and Community Manager for Nordix Foundation.