The Tech Content Creator Series (TCCS) is a monthly interview initiative where I talk to people in positions related to technical content creation. This includes technical writers, documentation engineers, developer advocates, and other similar professions. The goal of these conversations is to talk about what can inspire, motivate, and influence.
In open source support, Google Season of Docs, a paid internship program organized by Google, is held annually. Through this program, technical writers are given the opportunity to collaborate on global open source projects. The goal of the program is twofold: to improve technical documentation of open source projects and to give technical writers a platform to actively participate in them.
This month, as part of the #TechContentCreatorSeries, I took a particular approach. Instead of talking about any one person, I turned to three active interns in Google’s Season of Docs initiative – Amarachi, Nelson, and Funke. Through their reasoning and responses to critical questions, they provided invaluable advice and tips that can serve as a compass for those seeking to participate in the Google Season of Docs program.
Key Insights
- Comprehensive information about the application process can be found on the official Google Summer of Docs website;
- Before applying, it is essential to gain a thorough understanding of the proposed organization and its project. Demonstrating a thorough understanding of the scope of involvement in the project is critical;
- The likelihood of application approval is significantly increased if one is actively involved in open source projects prior to the selection phase. Active participation in projects and presence on the organization’s communication platforms, such as Slack or Discord, validate the candidate’s suitability;
- Experience in technical writing increases the chances of success. Having a portfolio demonstrating technical writing skills contributes to a positive evaluation.
Introduction and Background
Amarachi: My name is Amarachi Iheanacho and I am currently working as a technical writer at Moja Global as part of this year’s GSOD program. Moja Global’s mission is to combat the effects of climate change through software solutions that accurately estimate greenhouse gas emissions and removals in areas such as forestry, agriculture, and land use (AFOLU).
Funke: My name is Funke Faith Olasupo and I work as a Backend Developer and Technical Writer. My work as a GSOD intern is taking place at Open Food Facts in 2022. Open Food Facts serves as an open food database, facilitating informed dietary decisions.
Nelson: Greetings, I’m Nelson Michael, a frontend developer and technical writer. This year, I’m interning at GSOD with AsyncAPI. AsyncAPI provides asynchronous APIs with the AsyncAPI specification and a set of tools to make it easier to build and maintain Event-Driven Architectures (EDAs). To draw a parallel, the AsyncAPI specifications echo the role of the OpenAPI specifications for REST APIs.
Genesis of Interest in Technical Writing and Documentation
Amarachi: My journey into technical writing was started thanks to an unexpected tip I received on Twitter. Through this journey, it has become clear that writing articles not only helps me understand complex technical issues better, but also increases my credibility. The writing process itself demonstrates a deep understanding of the subject matter.
Funke: The impetus for writing the article was to describe the problems I encountered in the coding process and their respective solutions. The intention was to create a repository of knowledge that others could benefit from.
Nelson: The genesis of my interest can be explained by the fact that a friend of mine was doing technical writing at the time. Interested in this field, I asked him for advice to start my own endeavors. As a result, my first article was published on my blog, which was the beginning of an ongoing journey.
Motivation for Google Season of Docs and Project Selection Process
Amarachi: The reason for applying for GSOD was to pave my way into the Developer Relations department (DevRel). The prospect of working on documentation and contributing to open source projects adds a significant facet to my resume. Moja Global’s initiatives caught my attention, which ultimately prompted my application.
Funke: The lure of moving from a modest contribution to a key role in an open source project prompted me to apply for the GSOD. This initiative represented an unprecedented opportunity. An additional incentive was the financial reward that comes with contributing to open source. The application process involved aligning my aspirations with the goals of various organizations. I sifted through all the proposed organizations, settling on those that met my goals. Analyzing their proposals and matching them to my aspirations determined my choice.
Nelson: My motivation for participating in GSOD was the realization that it can be an insightful learning tool for understanding the dynamics of documentation. In addition, including GSOD in my portfolio promised to broaden my perspective. In terms of project selection, AsyncAPI’s approach was inclusive and invited candidates regardless of their documentation writing experience. This approach is what prompted me to apply.
Application Journey and Strategies for Selection
Amarachi: The path to becoming a technical writer involved writing lengthy articles explaining complex topics such as state-transition models, FLINT, and the like. I took the approach of breaking these concepts down into easily digestible material, which is akin to addressing a young audience. In addition, my involvement with Moja Global’s documentation work began with SheCodeAfrica’s Contributhon initiative. This active involvement strengthened my candidacy.
Funke: During the GSOD application process, I was interviewed by two different organizations, but only one of them bore fruit. In the context of applying to Open Food Facts, I directed my attention to emphasizing the synchronicity between the future aspirations of the project and my own aspirations. I showed how my experience could make a significant contribution. It also resonated strongly that my enthusiasm for food coincided with the mission of Open Food Facts.
Nelson: Given that AsyncAPI did not require proposals, I took a proactive approach by immersing myself in the community. I participated in discussions, responded to requests, participated in community surveys, and began contributing before the program began. This helped ensure that my presence was visible.
Proposal Compilation and Overcoming Challenges
Amarachi: Yes, submitting a proposal was part of the requirements. The proposals from Edidiong Asikpo and Gbadebo Bello were the inspiration.
Funke: Yes, submitting a proposal was an integral part of the CHAOSS application process. My proposal preparation plan included a thorough review of publicly available proposals and then aligning solutions with existing documentation. This strategy emphasized how my experience could contribute to better documentation.
Nelson: In my case, the proposal was not mandatory. Thus, I emphasized developing an active role in the community.
Hurdles Encountered and Strategies to Overcome
Amarahi: One of the challenges was deciphering and internalizing the source material. The solution was to actively ask questions, request resources, clarify assignments, and solicit feedback. Dividing complex tasks into manageable components also proved to be an effective strategy.
Funke: The problem arose during the Open API file compilation task, which was uncharted territory for me. The countermeasure was persistent searching and painstaking research work. I had to take mentorship and advice from senior technical writers in the organization.
Nelson: Understanding the full scope of the project presented a major obstacle at first. Remedial measures included a comprehensive introductory video, research work, and active participation in the community.
Experiential Learning and Future Prospects
Amarachi: My journey has been very enjoyable: I have honed my documentation skills, learned how to decipher complex resources and how to present them clearly to newcomers. I have also acquired better teaching techniques.
Funke: My path has been characterized by dynamism. Through the API documentation course, I have gained communication and teamwork skills. The opportunity to delve into API documentation was invaluable.
Nelson: The journey has been very fulfilling, and the metamorphosis in my perception of documentation has been particularly noticeable. The importance of structural integrity and information architecture in creating documentation has crystallized.
Post-GSOD Aspirations and Trajectory
Amarachi: After GSOD, my trajectory is toward working in developer relations development. My fusion of software engineering, technical writing, and community development serves as a solid foundation.
Funke: After GSOD, I intend to fully dedicate myself to technical writing. My skill set will extend to preparing documentation for various open source initiatives.
Nelson: My future compass involves getting a full-time job in developer advocacy, which has been put on hold to incorporate the GSOD program into my portfolio. My immediate plans include obtaining a Dev Advocate position.
The collective experience gained from the conversation is a treasure trove of advice for future GSOD participants and anyone involved in technical content creation.
In final
In conclusion, the Google Season of Docs program is a valuable opportunity to enter the field of technical content creation and open source collaboration. The points made by Amarachi, Funke, and Nelson provide useful guidance for those considering participating in the program and make the application process and journey understandable.
You can learn important information:
- Preparation: Start by familiarizing yourself with the GSOD application process on the official Google Summer of Docs website. Thoroughly research the organization’s goals and the intricacies of your chosen project;
- Involvement: Active participation in open source initiatives, as well as contributing to documentation development and participating in communication platforms, enhances your reputation as an applicant;
- Previous experience: Experience in technical writing and a well-crafted portfolio can significantly strengthen your candidacy;
- Proposal preparation: If a proposal is required, draw inspiration from existing proposals, align your solutions with the organization’s documentation goals, and highlight your technical writing skills;
- Overcoming Challenges: Obstacles are inevitable, but seeking advice, getting clarification, and breaking down tasks can make it easier to solve problems;
- Enhance learning: GSOD improves documentation skills, team communication, and understanding of complex concepts;
- Future direction: After GSOD, new opportunities arise. Transitioning to activities such as developer advocacy or technical writing is facilitated by the experience gained during the program.
To summarize, Google Docs Season offers a fascinating odyssey into the realm of open source and technical documentation. The insights shared by Amarachi, Funke, and Nelson shed light on the path ahead. As you contemplate your own path, remember that the impact of your contributions goes beyond this program and resonates with the open source community.