— a blog for knowledge base knacks and hacks
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.
There are some really great documentation sites in the software industry, both aimed at the end user and developers. Everyone can benefit from top-notch documentation.
Information architecture is distinct from the quality of your documentation writing. There are categories, there is order, and the structure (hopefully) makes sense.
If you offer any kind of product for your customer, but especially software, you'll need to produce some kickass user docs to go with it.
The docs-like-code approach attempts to bridge the gap between what is often seen as two distinct fields: engineering and writing.
We attended Write the Docs 2017, an inclusive community for technical writers - and anyone else interested in the wonderful world of documentation.