Season of Docs is Google Open Source’s new program to help technical writers contribute docs to open source projects by working with mentors and earning a stipend for the participating in the program.
Season of Docs is a unique program that pairs technical writers with open source mentors to introduce the technical writer to an open source community and provide guidance while the writer works on a real world open source project. The technical writer in turn provides documentation expertise to the open source organization.
In last week’s video, I discussed how my open source GitHub profile serves as my technical writing portfolio. I shared how my publicly accessible GitHub profile helps me demonstrate my technical skills, tech writing skills, collaborative skills, and flexibility and proficiency with tech writing tools.
Participating in Season of Docs and writing documentation for an open source project is an excellent way to build your tech writing portfolio.
Work with mentors
My favorite thing about Season of Docs is the opportunity to work with mentors. Contributing to open source projects is a daunting prospect; especially if you haven’t worked with GitHub and other open source tools before. Having a mentor who can guide you through the overwhelming parts of the process and is invested in your success is incredibly helpful.
Earn a stipend
After a successful project evaluation at the end of the program, Google will pay you a stipend calculated based on your location. For details, see Technical writer stipends.
If you find the project interesting and would like to work with me, apply to the program as a technical writer and select the Hydra Ecosystem project. And feel free to contact me if you need help coming up with a proposal for the project. I look forward to hearing from you 🙂
Bonus: To know about additional ways to find open source projects and then choose the project that’s right for you, check out this video:
I published a video about my technical writing portfolio! In this video, I talk about how my publicly accessible GitHub profile serves as my technical writing portfolio and helps me demonstrate my tech writing skills, my collaborative skills, and my flexibility and proficiency with tech writing tools. Check it out!
A few days ago, a colleague shared an article with me about the dummy puffins installed on islands to attract real puffins. I found the article fascinating and the puffins utterly cute (they are my new favorite bird). The story resonated with me more that I expected, but I couldn’t fathom why. So I filed it away in my mental cabinet and got back to work.
Today at the company-wide team meeting, we discussed the issue of lack of female leadership and diverse representation in the tech industry, and how we, as individuals, could play our part in remedying the situation. The discussion reminded me of a time a few months ago, when I was frustrated about the lack of diverse representation.
I am fully cognizant of my privilege to do things which I could have only dreamed of a few years ago: like attending the Write the Docs conference that I yearned to attend since I first heard about it, or see my absolute favorite YouTubers (John and Hank Green) speak IRL, or work at a brilliant startup building cutting-edge tech. The 20-year-old-me would be proud of where I am now. From her perspective, I have “made it” in life. I have a seat at the table.
And yet, more often than not, I find myself being the only one at the table that looks like me or sounds like me or does what I do.
For instance, consider the Write the Docs conference. It was the most well-organized, thoughtful, inclusive conference I have ever attended. Yet, I observed a lack of ethnically and culturally diverse speakers. Knowing the organizers’ intent of making the conference as inclusive as possible, the under-representation of minority groups certainly wasn’t their fault. One possible explanation was that the organizers hadn’t received many talk proposals from people belonging to underrepresented groups. That was even more infuriating. Why weren’t more people from diverse backgrounds volunteering to speak at these events?
Another thing I found myself complaining about constantly was the YouTube tech community. I LOVE the contemporary YouTubers in tech: Jarvis, Mayuko, Charli, and others present a realistic view of programming and design careers in tech. But there’s no substantial content about contemporary tech writing. Why wasn’t anyone making videos that I would benefit from?
The probable answer: Imposter Syndrome. As a brown, female, non-US person, I am familiar with the paralyzing fear that the Imposter Syndrome creates. The fear of being judged, being “found out”, coupled with a deep-rooted insecurity and inferiority complex – these are the demons I battle everyday. I know how scary it is to speak up, because if you are wrong, it might not only cost you your reputation and credibility, but also your job, your livelihood. Not every risk is worth taking.
But if I wasn’t willing to take the risk, what right did I have to ask someone else to do it so I could feel represented and validated? If I wasn’t willing to work through my discomfort, how could I expect someone else put themselves through it?
So I made a deal with myself: if I found myself complaining about any form of inequality or lack of representation, I would ask myself if the issue really matters to me, and if yes, I would step up and speak up. If I chose not to do that, I wouldn’t complain about it. Simple. It wasn’t enough to have a seat at the table. I had to use my newfound privilege to make room for more people at the table.
Joined Toastmasters to work on my public speaking skills, hoping it’ll help me speak well at conferences and events
Participate in events (like this and this) that feature non-traditional leaders in tech
Currently planning a talk proposal for next year’s Write the Docs conference(s)
Every step of the way, I battle my insecurities. The Imposter Syndrome makes me question my worth: Why would my opinion matter? There are smarter, more knowledgeable people out there, why do I deserve their attention?
That’s where the dummy puffins come into the picture: I am a dummy puffin. I want to be out there on the seemingly lonely island, just representing puffins, with the hope that smarter, wiser, more knowledgeable fellow puffins will show up and be encouraged to share their experiences and perspectives with the world. Because, in the words of the great Captain Holt:
In May, I announced a hiatus from blogging because my parents were visiting me in New York and I wanted to spend quality time with them. We had an excellent summer in the city – I have never seen them so relaxed and happy! Now they are safely back home in Pune and I am back to my routine.
The hiatus proved more beneficial and necessary than I expected. Not only did it cure my homesickness, but also gave me a chance to take a step back and rethink my purpose for this blog and its future. You see, the reason I started blogging consistently in 2018 was because I had a lot of things to say about life as a Technical Writer and the blog seemed to be the best medium to share my thoughts and experiences. But now I find that having this blog as my only platform is pretty limiting. I have so many more things to share, but not all of them fit the content structure of a blog post. Some topics are better suited to video content, while others need more long-form content, such as a full-blown course or even a book. Some topics are about my knowledge gaps that need collaboration with other content creators in the tech writing space.
So that’s what I want to do next – experiment with different content platforms that best suit the topic I want to discuss. I still want this blog to be my central platform, so I will continue writing blog posts and link to other content as and when I create it. I hope you find this experiment helpful and entertaining.
As you might know, I recently conducted a webinar about contributing docs to open source projects. In this blog post, I am answering few follow-up questions about the topic.
Vinaya Krishna asks:
How to acquire domain knowledge of these communities? (Since you work in Cockroach Labs, there are people who guided you there. But how did you start working on others? Is it just by browsing their pages? Or did you actually get KT from other fellow members?)
Acquiring domain knowledge of the project depends on the complexity of the project. For beginners, I would recommend that they start by just observing the projects that they are interested in – follow the repository, see which contributions are being made, participate in their communication channels (probably Slack or Gitter), and keep an eye out on the issues list. When you feel confident enough to make your first contribution, start small – pick the easiest issue you can find and get a win under your belt. This will help you get familiar with the process and tools, and then you can move on to handling the technical complexity of the project.
I cannot stress enough the importance of being self-motivated and self-reliant when contributing to open source projects. Remember that the project maintainers are most probably employed full-time elsewhere and are working on the project on their own time. We cannot expect them to handhold us through the project – so make sure to do your homework, try figuring stuff out on your own, and approach them only when absolutely necessary.
Can a for-profit organization use Github with their data confidential in it?
As far as I know, yes. So GitHub has two flavors: you can choose your GitHub repository private or public. The repositories that seek contributions are public repositories. But you can make your repositories private to keep your data confidential.
Can you please upload the PPT somewhere so that we can visit the links you had mentioned in the closing slides of PPT?
What are the prospects of getting a work permit or OPT after its completion (Since I am not sure whether it falls under STEM.)
Technical communication graduate programs don’t usually fall under STEM. Which means you get one-year OPT instead of three-years. But you also get CPT in your second year of the graduate program, which allows you to do a part-time internship while studying.
Getting a work permit (by which I assume you are referring to the H1B visa) is decided by luck – literally – since it’s a lottery system. Getting a job in a company which would sponsor your work visa is even more difficult. If your purpose of pursuing a Masters program is to eventually get a job in the US, I need to warn you that it is not a sure thing. I have discussed this issue in detail here: Frequently asked questions
Average tuition fees
Tuition fees vary from state-to-state. At Missouri S&T, the average tuition fees were $11000 per semester. But if you can get financial assistance through teaching assistantships, the burden of the fees lessens considerably.
I hope this blog post helps you make an informed decision about graduate programs in tech comm. If you have follow-up questions, feel free to comment on the post or drop me an email at email@example.com
My parents are going to arrive in New York soon and I want them to have every moment I can spare from work and all my attention. Thus my blog will be on hiatus until August. Till then, happy writing and be well!