Upgrade to Pro — share decks privately, control downloads, hide ads and more …

On Writing Technical Content for Tech Companies

On Writing Technical Content for Tech Companies

* Top misconceptions about writing technical content
* Before you write technical content
* While you write content
* Landing your first technical gig
* Free tools you should have

Samuel James

December 02, 2020

More Decks by Samuel James

Other Decks in How-to & DIY


  1. Technical Writing as a Side Hustle Lessons learned from writing

    technical blog posts for tech companies
  2. Agenda ❏ Top misconceptions ❏ Before you write ❏ While

    you write ❏ Landing your first gig ❏ Free tools you should have
  3. About Me ❏ Software Engineer (Based in Germany) ❏ AWS

    Community Builder ❏ Creator of HubOfML's Newsletter ❏ Technical Writer (Serverless, Containers, Machine Learning, AWS, and Occasionally GCP @samueljabiodun @abiodunjames
  4. ❏ I'm not good enough ❏ Writers must always write

    original pieces ❏ Writing takes a lot of time ❏ Writing does not take time ❏ Good writing is about the use of fancy and big grammars
  5. What's the Point • Understand your objectives. • What should

    readers take from it? • Teach or offer advice?
  6. Do Your Research • No one knows it all •

    You will gain perspectives by reading opinions from others • Writing becomes easy when researched well
  7. An Outline is Important • It helps you stay on

    track • It helps you narrow down your research • It's a contract between you and the client
  8. Less is more ❏ Compress what you mean into the

    fewest words possible ❏ Don't state what it's obvious ❏ Remove weeds
  9. Take special attention to the lead ❏ The most important

    paragraph is the first ❏ Buy readers and keep them sold till the end
  10. Don't leave readers hanging ❏ Lead readers to action items

    ❏ What should readers take away with them?
  11. Avoid passive voice when possible The goat ate the yam

    is better than The yam was eaten by the goat
  12. Make it simple It may rain is better than We're

    anticipating experiencing considerable precipitation
  13. The secret of good writing is to strip every sentence

    to its cleanest components. – William Zinsser
  14. ❏ Every word that serves no function ❏ Every long

    word that could be a short word ❏ Every adverbs that already carries the same meaning that's already in the verbs
  15. Warning! There are no hard written rules, but if you

    do these, you might increase the odds.
  16. Write. Write. Write. ❏ Share how you tackled that production

    bug ❏ Share what you just learned about AWS ❏ Just build your portfolio (medium, dev.to, personal blog)
  17. ❏ Title Case Converter ❏ Draw.io ❏ Plagiarism Detector ❏

    Grammarly ❏ Word Counter ❏ Text to Speech Reader