loading...

re: 9 Tips to Help You Improve the Most Underrated Skill in the Tech Industry VIEW POST

TOP OF THREAD FULL DISCUSSION
re: Nicely put. These two guides go into more detail of what good docs may look like: Google: developers.google.com/tech-writing... Microsoft: docs....
 

Hey Max, thanks for sharing these resources!

Fo proofreading, we would usually take a few steps:

  1. Defining docs KPIs/Goals to measure success, some examples:
    • What are we trying to make the reader achieve?
    • How much time should it take to complete the goal?
    • How many steps are required for success? can we reduce any?
    • How many iterations did the user need?
    • Were we right with our assumptions about preliminary knowledge necessary to achieve the document goal?
  2. Trying to follow the docs ourself, this will be by the author itself (not that trivial as it may seem :))
  3. Sharing the doc with teammates and even better, developers from our community.
  4. Having a feedback loop as long as possible, honestly, this might be affected by time constraints a lot of the time, but we try and do our best to make the process as useful as possible.
  5. Most of the time, we'll use a beta stage that might take weeks to help us gain more feedback from a wider audience.
  6. We will monitor the usage of our docs, just like a media company will monitor its content consumption (read time, user funnel, bounce rate, etc..).

At the end of the day, we want to treat the docs on our site as an equal part of our product, just the same way our API or developer dashboards are.

 

That's gold. I reckon an extra hour you put into making better docs saves hundreds of hours across the user base. Thanks for the detailed reply!

Sure Max! Would love to see join our Discord channel so we could chat more: discord.gg/GSeTUeA

code of conduct - report abuse