Presented by: Edidiong Asikpo, Hashnode Presented at All Things Open 2020 Abstract: The documentation of an open source project provides an avenue for users to not only understand the project but also make contributions to it. Surveys (https://cdn2.hubspot.net/hubfs/4008838/Resources/The-2019-Tidelift-managed-open-source-survey-results.pdf) have even shown that a good documentation saves as a sign of the healthiness of an open source project. However, technical writers still think they are not meant to contribute to open source projects because of the stereotype that only software engineers are meant to contribute to open source. In this talk, I will introduce the audience to how technical writers can contribute to open source projects, best practices, and it’s benefits.

1. The Technical Writers Guide to
Contributing to Open Source
Projects

2. Hello!
I am Edidiong Asikpo.
A developer advocate
and technical writer.
2

3. What is an open source project?
An open source project is a project whose
source code and documentation are made
available for use, modification, or enhancement
by anyone in the world.
3

4. The state of open source documentation
4

5. 5,500
Randomly sampled respondents
5

6. 93%
Complained about incomplete or confusing
documentation in open source projects.
6

7. The documentation of an open source project is arguably as
necessary as the software.
Therefore, technical writers are as important as software developers
in the open source ecosystem because humans can’t use or
contribute to what they don’t understand.
7

8. Why technical writers are important in open
source.
8
Based on the survey analysis, you will agree with me that there are
different people who decide not to use an open source project or contribute
to it because of the documentation.
When technical writers come onboard and become active open source
contributors, this problem will be solved, and more people will contribute to
or use more open source projects.

9. How to contribute to an open source projects
as a technical writer
Find a project
The documentation of
so many open source
projects is either
incomplete or
confusing, so there
are many projects that
you can improve.
Identiy an issue
If you don't see any
open documentation
issue on the
repository, then use
the project and
identify things that
should be
documented but
haven’t been.
Send a pull request
Identify and
understand the open
source project’s
review process. Then
follow that guide when
submitting your pull
request.
9

10. Some notable best practices
🔑 Follow a style guide (if it exists).
🔑 The page title should reflect the content of the page.
🔑 Always define what the page is about in the first paragraph.
🔑 Consider your audience when creating content.
🔑 Avoid duplicating content.
10

11. Benefits of contributing to open source
projects as a technical writer
📖 Your writing skill will improve.
📖 You expand your network.
📖 You can get recommendations and referrals.
📖 You can get accepted into the Season of Docs program.
📖 You become an Open Source contributor.
11

12. Conclusion
12

13. 13
Thanks!Any questions?
Blog
edidiongasikpo.com
Twitter
@didicodes