— a blog for knowledge base knacks and hacks
In the role of technical writer, the right tools have the potential to make your life so much easier. There are tools to help you write, publish, illustrate or collaborate – even tools to help you
On a limited budget, it’s often about producing more documentation in less time – while still maintaining quality and usefulness. What’s a documentarian to do?
Plain language has a very tangible benefit for your documentation. It makes your writing much easier to comprehend, and this contributes to the overall goal of your knowledge base.
Mozilla campaigns to keep the internet open and free. They also make a valiant attempt to document web development with their project MDN Web Docs.
Kayako and HelpDocs are masters when it comes to teaching users with their documentation
You hope your documentation would vastly improve with more firepower. Your challenge becomes how to keep quality consistent while producing content at scale.
With useful questions to ask about your company before you invest any significant time and resources into a new knowledge base.
Far from a boring technical necessity, documentation is a chance to promote your brand in front of existing and potential customers.
Contextual help is documentation presented in the software interface for a seamless learning experience.
Crowdsourcing your docs means harnessing the power of the many to produce useful help content for your users.