![]() We’ll also see how you can follow the lead of the best documentation out there and create your own documentation yourself. So in this post, we’ll explore the different categories of documentation, and the best documentation examples in those categories. It helps to take a look at brands that have done it successfully before you. However, writing your online documentation from the ground up is no mean feat. That’s why it’s crucial to have documentation that helps customers find answers to their questions without waiting for someone on your staff to reply. I will also illustrate how the presented ideas help to both improve user experience and make life easier for documentation contributors.Can your customers find solutions to their problems with your products or services on their own? And are they able to do so quickly and easily?Īnswering yes to both of these questions is a big part of providing a great customer experience and improving your customer satisfaction rate. It will then present the proposed solution to the problems and show specific examples of content modularization. The talk will introduce the terminology and explain the motivation for this work by describing the shortcomings of ‘legacy’ documentation. The presentation outlines an approach that a number of documentation teams at Red Hat have started to pioneer: turning existing content into modular units and developing new content in a modular manner, while employing content-strategy focused on identified, validated user stories. The two main topics of the talk are how to improve user experience with documentation, and how to reduce the maintenance burden on documentation writers. The talk will also outline how to leverage the modular structure of content to present it to users in a dynamic manner - using a metadata-based, hierarchical navigation. How to adapt the big guides of yesterday into modularized narratives that are easy to maintain, scale well, and still allow for a ‘guide-like’ experience when it is required? This presentation will describe the work documentation writers at Red Hat are doing to solve this problem: re-purposing the existing body of documentation into modular units that can be combined into user-story-based content.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |