Credits:
Image by Samson Katt on Pexels Good docs have (at least) six key characteristics:
Findable Accessible Legal Accessibility Language Accessibility Scannable Searchable Timely Complete Findable For documentation to be worth the time spent creating it, the user needs to be able to get to those docs when a problem or curiosity creates a need for information. The best docs do nobody any good if they can’t put their hands or eyes on them when they need them.
Credits:
Image by Suzy Hazelwood on Pexels Are docs a good investment? One of the challenges every documentarian faces is justifying the investment in docs.
Whether that investment is
salary training and professional development expanded doc team tooling dev help for site development It can feel like we technical writers are always battling it out for the company’s money. And, often, the experience is that the money for conferences or books or a new team member goes to other teams instead.
Credits:
Photo credit: by Brett Jordan at Pexels What makes a good technical document? A good technical article, document, or topic has a few key points that make it stand out:
It understands the user and has empathy for the situation that brought them here, now.
Don’t miss this point. It’s key.
A good technical article has to be inside the mind of the user that’s come to the article.
Credits:
Photo by Mat Brown from Pexels So you’ve done the work and you are ready to convert your docs from one tool to another.
I, too, have done this. Actually, I am on my third time through doing such a massive undertaking. This time, as a lone writer having to maintain docs in both the old platform and the new.
It’s an undertaking.
Here’s some advice from a conversion veteran.
