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
Tweet

More Decks by Samuel James

Other Decks in How-to & DIY

Transcript

  1. Technical Writing as a
    Side Hustle
    Lessons learned from writing technical blog posts for tech companies

    View full-size slide

  2. Agenda
    ❏ Top misconceptions
    ❏ Before you write
    ❏ While you write
    ❏ Landing your first gig
    ❏ Free tools you should have

    View full-size slide

  3. Acknowledgement
    ❏ Abraham Enyo-one Musa ( Thanks for pushing for this)

    View full-size slide

  4. 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

    View full-size slide

  5. Top Common
    Misconceptions

    View full-size slide

  6. ❏ 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

    View full-size slide

  7. Before You Write

    View full-size slide

  8. What's the Point
    ● Understand your objectives.
    ● What should readers take
    from it?
    ● Teach or offer advice?

    View full-size slide

  9. Do Your Research
    ● No one knows it all
    ● You will gain perspectives by
    reading opinions from others
    ● Writing becomes easy when
    researched well

    View full-size slide

  10. 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

    View full-size slide

  11. The Outline is Ready.
    What's Next?

    View full-size slide

  12. While You Write

    View full-size slide

  13. Less is more
    ❏ Compress what you mean into the fewest
    words possible
    ❏ Don't state what it's obvious
    ❏ Remove weeds

    View full-size slide

  14. Take special attention to the lead
    ❏ The most important paragraph is the first
    ❏ Buy readers and keep them sold till the end

    View full-size slide

  15. Don't leave readers hanging
    ❏ Lead readers to action items
    ❏ What should readers take away with them?

    View full-size slide

  16. Avoid passive voice when possible
    The goat ate the yam is better than The yam was
    eaten by the goat

    View full-size slide

  17. Make it simple
    It may rain is better than We're anticipating
    experiencing considerable precipitation

    View full-size slide

  18. The secret of good writing is to strip every
    sentence to its cleanest components.
    – William Zinsser

    View full-size slide

  19. ❏ 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

    View full-size slide

  20. Be cohesive
    ❏ Use cohesive devices

    View full-size slide

  21. Landing Your First
    Technical Writing
    Gig

    View full-size slide

  22. Warning!
    There are no hard written rules,
    but if you do these, you might
    increase the odds.

    View full-size slide

  23. 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)

    View full-size slide

  24. Partner with established technical writers
    ❏ You will learn a ton
    ❏ You may also get connected

    View full-size slide

  25. Use online marketplace
    ❏ Fiverr
    ❏ Upwork, etc

    View full-size slide

  26. Share what you write
    Nobody lights a lamp and put it under the bushel
    – Bible

    View full-size slide

  27. Free Tools I
    Use

    View full-size slide

  28. ❏ Title Case Converter
    ❏ Draw.io
    ❏ Plagiarism Detector
    ❏ Grammarly
    ❏ Word Counter
    ❏ Text to Speech Reader

    View full-size slide