Your Web News in One Place

Help Webnuz

Referal links:

Sign up for GreenGeeks web hosting
August 16, 2022 09:54 pm GMT

Contributing to docs!

Over the past one year I have done a LOT of documentation work. I impart a little knowledge in this blog! So let's go -->

Why contribute to docs.

It's a gateway contribution towards open source organizations.

  • You gain a lot of surface level knowledge about an organization before you know which part of the organization you REALLY want to contribute to.
  • It's a fantastic opportunity to learn about the community- is it an active community, are the people warm and welcoming, is the communication transparent and public, etc.
  • Documentation, in my perspective, is comparable to dirty laundry. Everyone wants clean clothing at the end of the day, even though nobody wants to do it!

Everyone has their pet contribution, documentation happens to be mine.

Guess what? Documentation can be your gateway / foot in the door contribution as well.

Resources and tools

As Taylor Swift says:

"I really do think we are all writers. And most of us write in a different voice for different situations. You write differently in your Instagram stories than you do your senior thesis. You send a different type of email to your boss than you do your best friend from home. We are all literary chameleons and I think its fascinating."

So we ALL are writers! I believe that the
Technical writing by Google developers is an excellent resource to learn about some general technical writing rules!

Easlo's tweet suggests some great tools to make that your writing is crisp. They are:

  1. GrammarlyWrite mistake-free.
  2. QuillBotRewrite any paragraph or article.
  3. HemingwayMake your writing bold and clear.
  4. CopyAICreate marketing copy in seconds.

Original Link: https://dev.to/chicken_biryani/contributing-to-docs-27am

Share this article:    Share on Facebook
View Full Article

Dev To

An online community for sharing and discovering great ideas, having debates, and making friends

More About this Source Visit Dev To