Open source technical writing opportunities
Looking to make an impact? These open source projects need technical writer help.
Many of our readers at Technically We Write are working professionals with many years of experience in technical writing. But we also know much of our audience is students who are still learning about technical writing. We wanted to find ways to connect these students with technical writing opportunities, and help other projects that need it. It's a win-win for everyone.
We asked specifically for open source software projects that could use help with documentation: writing the docs, editing the docs, converting the docs, or other technical writing tasks. And you answered! Here is what our community suggested:
Medley Interlisp Project is looking for help:
We would appreciate help with tasks such as converting OCRed scanned documentation PDFs to usable formats, possibly native to Interlisp. We can also discuss ideas in other areas.
The Medley Interlisp Project revives and modernizes the Interlisp development and system environment created at Xerox PARC between the 1970s and 1980s. Some of the original developers and users founded and contribute to the project.
Dustin Mitchell suggested a man page conversion:
Taskwarrior has some decent docs already but they suffer from being written long ago and being heavily patched. It also has man pages in troff that could use a conversion to a more writable format.
—Taskwarrior is free and open source software that manages your TODO list from the command line.
Amin Girasol pointed to the Fujinet project:
The students who are interested in the sociotechnical aspects of technical writing in a team setting may be interested in attempting to interact with the Fujinet community. Everyone in the community understands the documentation is a shambles, but a handful of opinionated gatekeepers block actual progress.
Most of the discussion about Fujinet happens on their Discord.
—FujiNet is a multi-peripheral emulator and WiFi network device for vintage computers.
Another reader recommended contributing to a wiki:
Does the Gentoo Linux Wiki count? Or perhaps more specifically the Gentoo Handbook.
—Gentoo Linux is a highly flexible, source-based Linux distribution.
Kevin wrote about another Linux distribution:
Alpine Linux is struggling with documentation and could use help.
—Alpine Linux is a security-oriented, lightweight Linux distribution.
Jeroen Baten suggested several projects at once:
Try the Ardour project— "record, edit, and mix on Linux, macOS and Windows." And the LibrePlan project— "LibrePlan is an open source web-based project management application." And probably thousands more!
JabRef asked for documentation help:
We would appreciate some help with our user documentation as well. For the most part, it's describing new features and or updating/clarifying existing functionality. See JabRef documentation at GitHub.
—JabRef is an open-source, cross-platform citation and reference management tool.
Jeremy Monat says RDKit needs documentation help:
For example, splitting RDKit Documentation into a page per topic so search results would lead more immediately to the desired code?
—However, Greg Landrum replied and questioned if this is the right approach. This could be an interesting starting point for a discussion.
Paul also suggested working with the MDN Web Docs site:
You may want to have a look at what the MDN team are doing over at Contribute to MDN.
—MDN Web Docs is a comprehensive online resource for web developers that provides documentation on web standards like HTML, CSS, and JavaScript.
Penguin42 suggests joining LibreOffice's documentation effort:
LibreOffice's documentation team starting point is the Document Foundation Wiki.
—LibreOffice is a private, free and open source office suite, compatible with Microsoft Office/365 files and is backed by a non-profit organisation.