Published: December 27, 2019
When you first started to learn about programming.
Are you forced to learn to write documentation you are just given something to "write hello world"?
As I progress as a developer, it did not occur to me that learning to write is one of the most essential skills we need to learn as a developer.
As without it, tons of wasted hours of work is done.
Due to our lack of understanding and clarity in conveying it to people.
I encountered the same problem while I was trying to communicate to doing something.
Which resulted in a drastic difference in technical implementation when another developer was implementing it.
I remember while I was listening to one of the Tim Ferriss show.
He was interviewing one of the founders of Airbnb or Spotify on recruiting engineers for their startup.
The founder responded that he looks at other areas and not just the technical code that the engineer wrote.
Instead, it was the scribbles in the piece of paper to understand how they broke down and solve the problem.
As an engineer are hired based upon how they wrote on the solution before coding their first line of code.
The additional perk of writing well and clear is the need for back and forth exchange on what is to be implemented.
When you are communicating with the client or user.
I always love the idea of KISS so that you communicate your intent.
Even when someone does not have the background knowledge or context to understand the whole project.
Therefore I would advise that you strive to write for a layman.
Plus with the rise of tools like Grammarly.
It has become much easier to write better through the rapid feedback from either an actual person or AI to help you to write better.
If you are an API developer, one of the keys for API adoption is the existence of high quality documentation.
Invest and place a premium in quality writing for their technical documentation.
Since without that, I believe they will be unable to attract new developers or convince development teams to use their product or services.
So that it allows me to get started by installing and using that package to accomplish a feature that I would like to deliver for my project.
Beside contributing code, you could always help through documentation.
To make it easier for someone to get started in using the software.
I did something similar when I was rewriting documentation for one of the Python guides in Freecodeamp.
I hope that you can gain a better insight and would be interested to learn to write well as a developer.
Instead, it is about the human problems we are trying to solve with the right context.