We're sorry but this page doesn't work properly without JavaScript enabled. Please enable it to continue.
Feedback

Bridging the Gap between Legacy Docs and Modular Content

Formal Metadata

Title
Bridging the Gap between Legacy Docs and Modular Content
Title of Series
Number of Parts
611
Author
License
CC Attribution 2.0 Belgium:
You are free to use, adapt and copy, distribute and transmit the work or content in adapted or unchanged form for any legal purpose as long as the work is attributed to the author in the manner specified by the author or licensor.
Identifiers
Publisher
Release Date
Language
Production Year2017

Content Metadata

Subject Area
Genre
Abstract
How to turn legacy docs into user-story-based, modular content to better serveusers while reducing maintenance load and overall amount of docs. It has become cumbersome to wade through chapters upon chapters of docs,looking for the relevant bits, especially with the advent of embeddedapplications, container deployments, and other usage scenarios that targethighly specialized use cases. We need topic-based, action-oriented content toguide users through specific tasks. So, how do we turn the voluminous guidesof yesterday into lean, modularized narratives that are easy to maintain,scale well, and still allow for a ‘guide-like’ experience when it is required?In this presentation, Robert Kratky will describe the work docs writers at RedHat are doing to solve this problem: re-purposing the existing body ofdocumentation, so that its parts – adapted into modular units to allow forreuse – can be dynamically combined. Traditionally, Linux documentation has been perceived as lacking in userfriendliness and oftentimes in quality or scope. This presentation will helpattendees understand what problems Linux (and OSS) documentation faces, whatis being done to remedy the problems, and how can existing documentation beimproved or re-purposed to address future requirements and user expectations.The audience is anyone interested in documentation for Linux and open-sourceproducts, which includes technical writers, content strategists, supportengineers, developers, and members of management who want to understanddocumentation processes and new methods of supporting users throughdocumentation. Attendees can expect a presentation and discussion of ways tomodernize existing documentation and adapt it for new expectations with regardto content consumption.