Learn Akamai: A New Approach to Documentation

by Keith McGrath
315

Akamai’s product documentation is about to get a lot easier to find and use. Our Product Experience Documentation team just completed a transition from existing documentation legacy tools to a completely new XML/DITA-based tool set and a robust content management system. This new documentation and user-assistance paradigm provides a powerful one-two punch for creating and publishing world-class documentation.

The CMS publishing platform advances our goal of improving our documentation experience and benefits customers in significant ways:

  • It allows for modular and reusable content, an approach where we can write content once (and translate it just once as well), then use it over and over again. As our writers create and store content in the CMS, it will become easier and easier to repurpose chunks of each other’s work, ready-made, across Akamai’s product lines or technologies.
  • This flexibility of content creation lets us publish to a number of formats, including traditional outputs like web-based help and PDFs, and newer outputs like EPUB and MOBI. Ultimately this means allowing you to find the right information, in the right place, at the right time.

This year at our Edge Conference, we’re excited to announce a major benefit of these content creation and publishing infrastructure efforts with the launch of Learn Akamai, Akamai’s new home for help, product docs, quick start guides, release notes, and more. Anyone can quickly find the assistance they need with easy-to-use navigation and integrated search. Best of all, content is available publicly at learn.akamai.com and discoverable by major search engines.

Over time, content on Learn Akamai will continually improve and grow, contributing to better self-serviceability and new opportunities for user, admin, and developer learning. In early 2018, product docs and help available in Luna Control Center will be replaced with a non-public version of Learn Akamai with additional content.

This is a major step forward in our efforts to improve the customer experience with Akamai’s product documentation. This is only the beginning, and it’s only going to get better and better!

Categories: Technology

Suggested Article

LEAVE A REPLY