Integrating Into FOSS World: How Bad Documentation Can Scare Applicants Away

Integrating Into FOSS World: How Bad Documentation Can Scare Applicants Away

Documenting For A Better World!

There’s a constant urge to bring new contributors to FOSS communities. A lot of it is obviously because of the open-source and free characteristic of these communities. However, FOSS communities need new blood for much more than just help with their code issue and volunteer work.

Analyzing how new contributors feel when trying to immerse themselves in a community brought the need to document and expose it here. FOSS communities are so full of the same kind of people, tech-oriented, contributors to other similar communities, that a human factor to integrate new users is failing. This becomes clear when reviewing all the doubts from Outreachy Applicants that come to me (and I’m not even a mentor).

What I see is two different things:

  1. A friendly, welcoming speech;
  2. Frightening documentation;

People in these communities are often volunteering and overwhelmed with their own share of projects from the community. It’s natural that they don’t get the time to hold an applicant’s hand and guide them through all the processes. Therefore, all that new contributors can count on are the tutorials and documentation provided by said community. And there is where the breaking point is happening.

Slightly outdated documentation sometimes is unavoidable, and we can give it a free pass when it comes to FOSS communities. Nonetheless, when the introductory documentation is scattered among different sources/Websites or when it doesn’t have a clear path to be followed, it demotivates new contributors.

To document something is a human equivalent of holding someone’s hand and giving this person a tour through our main activities and interests. Are we even doing it as a FOSS community? Are we enabling easy and clear paths for new contributors? Or do they feel constantly lost? Agonizing because they feel like it doesn’t matter how much they read they can’t grasp how the community works?

FOSS communities need new blood to get out of all the tech-related tasks and reconnect with humanity. We need to understand that our flow as a particular community can be completely different from another, and it can be extremely confusing.

So the question is: How can we make it better? How can we be the most human possible with newcomers?

What about we stop thinking as veterans in the community, assuming that certain things are ‘obvious’, and begin documenting this properly?

  • Do we need to chart a process flow so an applicant understands better the steps to contribute? Let’s do it!
  • Can we centralize all our initial guide at one place to make it easier? Awesome!
  • Is it possible to turn the reading process less time consuming using UML diagrams and mind maps? Great!

This is the kind of worry that a FOSS community needs to have. New contributors’ insight is very important to reach that point where an introduction process gets organic and natural. And as communities that depend on new people, we so desperately need to think like that.

I’m not talking about new, small/growing communities. This is a generalized problem. From giant communities to small ones. Applicants get so frustrated because they don’t feel a natural clear process to be immersed in the community. I have been seeing people giving up Outreachy helping FOSS communities because of this problem.

We need to change how we document, we need to understand how important it is to have organic and welcoming documentation. We need to begin giving more value to our Writers. Because documentation can change experiences and help FOSS communities grow even more.

Copy?

Over.

The Myth of the Perfect Professional

The Myth of the Perfect Professional

Very often I meet friends, colleagues, workmates, internet acquaintances and also some not so acquainted beginning careers as myself. Something that came into light recently is how many of us struggle with the professional image that we idealize for ourselves.


Legend says that by 20 we all should know what to do, what we want to achieve. Around 30 there’s this pressure not only to know what we want but how to achieve it. The myth of the perfect professional has been bringing a lot of impostor syndrome to all of us.


It’s so easy to log in Linkedin and scroll through a feed where all our friends have great achievements and seem to be thriving perfectly in their careers. The Selective Success has spread from Instagram and Facebook to haunt professional beings.


Despite all that we see, it’s important to understand that this is just the pretty side of the embroidery. Turn it back and you will see the mess. Getting our professional life together is hard and not every day is productive. Working with a mentor, as I am right now, can be challenging for some people as they tend to think that they are the only ones struggling.


Being an Outreachy Intern made me realize how important it is to share our struggles. During our first meeting between alumni and new interns, we talked about our first week tackling our respective tasks. People mostly said that they were doing fine, but eventually, everyone opened up and exposed their feelings.


Some of us aren’t having any technical problems with our tasks, but realizing that it’s a bit overwhelming with all the new environment is important to show to others that it’s completely ok to be struggling.


We must take this to our professional journey, we need to accept that struggles will come and that’s alright to suffer with them.
I must admit that although I considered myself a very private person that worried about online security I had to Adapt. After having more contact with the Tor community there were tools and methods to be learned and used that I wasn’t expecting. Encrypting my e-mails was never something that I’ve considered doing, but it was necessary.


I struggled to try to understand the hundreds of different options to PGP encryption and trying to make something work out with my e-mail server. I felt like a tech noobie asking questions to my mentor and everyone in the community. Questions that now, two weeks later, I can see how shallow and easy they were.


Asking for help is necessary, it’s a process that may help us grow even though it may be embarrassing sometimes. With my mentor’s help, I was able to set a nice add-on on my e-mail to encrypt everything. It was something that I had tried to do for one entire week before giving up and asking for help.

So don’t let impostor syndrome crawl into your skin simply because you struggled about something. Asking for help and sharing problems don’t diminish your expertise and worth as a professional. If anything, it makes you a better person!

Copy? Over.