The VTune Profiler Installation Guide
Context:
As part of a larger effort to remove stale content and update the most visited topics in the VTune Profiler documentation set, I examined the Installation Guide for this product. This document is the first piece of technical documentation for the product that our customers use. The installation process and scenarios had changed over the years, and it was time to update the document.
The Work:
As I made notes on the sections in each topic that needed updates, I had to keep a parallel track of software development changes and types of support. I also noticed that the language and terminology in this document were not consistent with other documents in the set. If I was getting confused with the content, it was only natural that our customers would get frustrated as well.
I love to bring clarity to complex content. When I refactored this document, I clarified basic terminology and created a tabular representation of available installation options.
I rewrote every topic in this document after completing some installations myself and engaging with application engineers to complete the ones that required additional permissions.
I moved key topics on running this product as a web server from the user guide into this document. Finally, I created a new topic on operating models to better describe the various scenarios in which users could incorporate this product.
Post a comment