Skill #14: Contributing to Open Source Projects
An open source project is a software program that’s open for anyone to use or modify as they see it. For example, a developer—anywhere in the world—could create an open source project that gives users real-time updates on the location of, let’s say, city buses.
The developer had the idea, coded the software, then released a rough version to the world. It likely has bugs and missing features. But because it’s open source, anyone who’s interested in the project can use their expertise to make the project better—including technical writers.
As you’ll learn in this episode, documentation is essential to a successful open source project. However, for developers actually coding the software, documentation is an afterthought. The result: possible users don’t know what the software does—and even if they do—they struggle to figure out how to use it.
This is where technical writers—both new and seasoned—can use their skills not only to contribute to the beauty that is open source projects, but also challenge themselves to learn new types of documentation.
To help us unpack this skill, I’ve got Kyle Taylor, solutions architect at FFW and President of a Denton-based technology nonprofit TechMill, on the podcast to share with us how technical writers can contribute to open source projects, including:
- how to choose the right project to contribute to
- how to translate your contributions into your portfolio
- how to create open source documentation that developers will love.
Show Notes:
Creators and Guests
Host
Jacob Moses
Jacob Moses is the founder and original host of The Not-Boring Tech Writer podcast, which he launched in 2016 to celebrate tech writers and push back against the stereotype that technical writing is boring. He studied technical communication at the University of North Texas, and his first gig out of college was as a tech writer at Rainmaker Digital (formerly Copyblogger Media). Since then, he's carried the skills and values he cultivated as a tech writer into community development and real estate. Today, Jacob is owner of Care Block Development, a real estate development company that acquires, rehabs, and manages historic buildings in Denton, Texas. Pairing historic preservation with thoughtful improvements, Care Block honors the culture of the neighborhoods in which it works to create lovable places for the people it serves. He's also the owner of Sardinha, a premium tinned seafood pop-up pushing premium tins in Denton. If you need a tinfish plug in Denton, Jacob is your guy.
