As a technical writer interested in learning docs-as-code, volunteering in open source can be a great way to gain experience and develop your skills. It’s a path I took early in my career; I learned what I wanted to know by volunteering in open source. You can take the opportunity to work with other professionals in the field, and you’ll also be contributing to a project that benefits the broader community. Here are some tips on how to get started:
- Choose a project that interests you: The first step in volunteering in open source is to find a project that aligns with your interests and skills. Look for projects with active documentation efforts that could benefit from your technical writing skills. You can find open-source projects on sites like GitHub, GitLab, or Bitbucket.
- Get to know the community: Before getting started, take some time to get to know the community surrounding the project. Read through the project’s documentation and code, and look at any issue trackers or forums where discussions occur. This will help you understand the project’s goals and how you can contribute. Look at some Trends and Open Source Writing.
- Identify areas where you can contribute: Once you’ve identified a project and gotten to know a few community members, look for places to contribute. This might include updating existing documentation, creating new documentation, or working with developers to improve the documentation workflow. Consider starting with small contributions, like fixing typos or clarifying confusing documentation sections, before tackling more significant tasks.
- Learn the tools and technologies: To contribute to a docs-as-code project, you’ll need to be familiar with the tools and technologies developers use. This includes version control systems like Git, markup languages like Markdown, and static site generators like Jekyll or Hugo. Take time to learn these tools and technologies, or contact the community for guidance. The DocsLikeCode.com/Learn area has tutorials to get you started.
- Engage with the community: As you work on the project, engage with the community by participating in discussions and sharing your work. Be open to feedback and willing to make changes based on input from others. This will help you build relationships with other contributors and better understand the project. I’ve got another article, How to Build OpenStack Docs and Contributors through Community, that may help. We even held an OpenStack Docs Boot Camp one year to get to know each other.
- Highlight your contributions: Finally, highlight your contributions to the project on your resume and in future job applications. Potential employers look at your contributions to open source and your experience working in a docs-as-code environment.
I’ve found that volunteering in open source can be an excellent way for technical writers to learn docs-as-code and gain experience working with other professionals in the field. By following some of these suggestions, you’ll be well on your way to building a successful career in technical writing. Be sure to check out Google Season of Docs if you’d like to participate in a structured way.