Open source projects can seem overwhelming because they involve code and technical terms. It’s true, but that’s where you come in as a technical writer.

Documentations don’t write themselves, and neither do developers spend time making sure they serve their purpose. Projects require a lot of work, but documentation is important for users to understand a product. Therefore, there is a need for the services of a technical writer.

As a beginner technical writer, how and why should you contribute to open source? What do you need to get started? Read on to find out.

Table of Contents

• What even is open source?

• What’s all the fuss about contributing to open source?

• How do I get involved as a technical writer?

• Where do I start?

What Even Is Open Source?

Open source is simply a type of software or project whose source code is freely available to the public. It means that anyone, including developers and users, can view, modify, and distribute the code. It creates room for collaboration and knowledge sharing.

This open environment fosters a sense of community, as everyone can collectively contribute to the growth and success of the project and content.

What’s All the Fuss About Contributing to Open Source?

If you're new to technical writing, you might wonder why you should explore open source projects. Here's where your skills come into play:

Filling the Documentation Gap: open source projects often lack comprehensive and user-friendly documentation. This is where your expertise as a technical writer shines. When you contribute, you help make technical information easier for users to understand.

Sharpening Your Skills: Open source projects provide a practical way to improve your technical writing skills. You'll learn to simplify complex concepts, write clear instructions, and adapt to diverse project needs.

Portfolio Enhancement: Your contributions to open source become valuable entries in your portfolio. They showcase your ability to collaborate, communicate effectively, and create user-centered content.

Community Engagement: By contributing to open source projects, you can connect with developers, designers, and writers in a community. You'll learn from their experiences, share your insights, and build a professional network.

How Do I Get Involved as a Technical Writer?

Starting as a technical writer in open source projects may seem unfamiliar, but don't worry; there's a clear path to follow.

Identify Your Interests: Begin by identifying your areas of interest and expertise. What software or projects align with your skills and passions? This will make your contributions more enjoyable and impactful.

Research and Explore: Take time to research open source projects that match your interests. Explore their documentation, source code, and community. Pay attention to projects that explicitly mention their need for technical writers.

Reach Out: Don't hesitate to reach out to project maintainers or the community. Introduce yourself and express your interest in contributing as a technical writer. Ask questions and seek guidance on how you can best support the project.

Start Small: For your first contributions, consider tackling smaller tasks like improving existing documentation, fixing typos, or clarifying instructions. This helps you get familiar with the project and its workflow.

Collaborate: Actively participate in project discussions and collaborate with developers and other contributors. Engage in conversations, attend meetings, and use communication channels like mailing lists or forums to stay connected.

Learn by Doing: Open source is a learn-by-doing environment. Don't be afraid to make mistakes, ask for feedback, and iterate on your work. Your skills will grow with each contribution.

Document Your Work: Keep track of your contributions and maintain a portfolio. This documentation will serve as evidence of your skills and commitment to potential employers.

Stay Committed: Consistency is key. Regularly contribute to the projects you're passionate about. Over time, your contributions will make a significant impact.

By following these steps, you'll gradually become a valuable contributor to open source projects as a technical writer, gaining experience and making a positive difference in the community.

Where Do I Start?

The journey of contributing as a technical writer in open source begins with a few practical steps. Here's a roadmap to guide you:

Create Your GitHub Account: If you don't already have one, sign up for a GitHub account. GitHub is a hub for many open source projects and will be your contribution platform. You could also try GitLab as an alternative.

Select Your Tools: Familiarize yourself with version control systems, Git specifically, as it's widely used in open source. Install Git on your local machine and choose a code editor for writing and editing documentation.

Explore GitHub Repositories: Start by exploring GitHub repositories related to your interests. Use GitHub's search and filtering options to discover projects that require technical writing contributions.

Contribute to Existing Projects: Begin your journey by contributing to existing open source projects. Look for issues labeled as documentation, good first issue, or beginner-friendly. These are ideal for newcomers.

Fork and Clone: When you find a project to contribute to, fork the repository to create your copy. Clone it to your local machine, allowing you to work on the documentation.

Make Improvements: Address the identified issues by making improvements to the project's documentation. Ensure your contributions are clear, concise, and align with the project's style and tone.

Submit Pull Requests: Once your changes are ready, create a pull request to propose your documentation improvements. Project maintainers will review your work, provide feedback, and eventually merge your changes.

Engage with the Community: Actively participate in the project's community. Attend meetings, join discussions, and seek guidance when needed. Building relationships with project members can enhance your experience.

Stay Informed: Keep an eye on project updates and changes. Staying informed about project developments will help you make timely and relevant contributions.

Remember that contributing to open source is a learning process. It's okay to start small and gradually take on more significant tasks as you become more familiar with the community and project workflows.

Your contributions will not only enhance your skills but also play a vital role in improving open source projects for users worldwide.

Worthy Mentions

Here is a list of resources that would come in handy on your journey of contributing to open source as a technical writer:

The Good Docs Project has a repo filled with free templates of various documentation types you can use.

Write the Docs has a comprehensive list of valuable resources you may want to check out.

First-contributions provides you with a simple tutorial on making your first contribution.

Up For Grabs has a curated list of projects tagged documentation that you can explore.

Conclusion

There’s so much in store for you on this journey, but it is a rewarding one. Now that you understand the what, why, and how, you’re well on your way to making your first contribution. Finally, do more research to make the most out of your experience.