![]() | ![]() |
---|---|
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
ADMIN GUIDES
At EMC, the RecoverPoint Administrator's Guide and everything in it is my sole responsibility. The Administrator's Guide is in FrameMaker format. I reworked all of the content, creating a brand new guide which I illustrated, structured and optimized for single-sourcing to the online PDFs, the online help, and to a user-guided documentation delivery system.
![]() | ![]() |
---|---|
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
REFERENCE GUIDES
I am also solely responsible for the RecoverPoint Command Line Reference and the RecoverPoint Glossary, which I created from scratch.
Since most of the content in the CLI Guide also required entering into the product code, I set myself up on the same development environment as the RecoverPoint developers, so I could edit the content, simulate my changes in the product, and push my changes directly to the source code. I used a Rubi script to rip the content directly from the source code and push it to the CLI Guide, single-sourcing backwards, to ensure that there were no descrepancies between the guide and the product.
The content in these guides was in such demand, I automated its conversion from FrameMaker to Babylon format so I could deliver it to the RecoverPoint team automatically, after every content update. Using Babylon, everyone on the RecoverPoint team was able to display the content at the click of a button, in context, from any desktop application.
























TECHNICAL ILLUSTRATIONS
Another one of my sole responsibilities at RecoverPoint is providing all of the technical illustrations.
![]() | ![]() |
---|---|
![]() | ![]() |
TOOLS
I believe documentation can take any form. I love finding the right media to deliver technical content dynamically and interactively, whenever possible, Check out some of the tools that I've created to help end-users as well as company employees to find and use the content that I work so hard to create, quickly and easily.
![]() | ![]() |
---|---|
![]() | ![]() |
![]() | ![]() |
STANDARDS AND PROCEDURES
To perform the job efficiently, I've had to learn a few skills and create a few processes. Some of the processes that I've instilled at RecoverPoint are:
-
Externalization of all UI strings from the product code by developers
-
Language review of all UI texts
-
Single-sourcing to PDFs, Babylon, RTF and Help
-
Language standardization through a RecoverPoint Glossary
I also learned how to pull, compile, edit, simulate, and push the product code, and then documented the process for the rest of the technical writers,
![]() | ![]() |
---|---|
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() | ![]() |
![]() |
ONLINE HELP
Here are some screenshots of the context-sensitive online help that I single-sourced from the RecoverPoint Administrator's Guide using Mif2Go and RoboHelp.