Stuctured Authoring in Arbortext and DocZone

Below you’ll find a few projects I’ve completed using XML authoring tools. These documents don’t merely represent the ability to use common technical writing tools, but instead represent my ability to undertake large publishing projects. The synopsis included in the writing sample download will illustrate the story for the reader.

Skills

  • Technical Writing/Editing

  • DITA

  • Interviewing Subject Matter Experts

  • Following a House Style Guide

  • Project Management

Tools

  • Arbortext

  • DocZone/Oxygen/XMetal

  • Windchill

  • Matrix

  • Company Intranet

For a PDF file of the writing sample, complete with the synopsis page, please click the button.

If it’s easier, you can also find my portfolio pieces hosted externally here.

You may also download each piece of the writing sample individually by clicking on each photo below.

Stuctured Authoring Continued

I’ve been working with advanced authoring tools since the beginning of my career. Below is an excerpt from my master’s thesis describing the Arbortext structured authoring I performed as an intern for Southwest Airlines. Southwest is home to one of the top-rated internship programs in the U.S.

Figure 8 and 9 Synopsis

The following depicts what an XML authoring environment looks like. Figure 8 shows the cover page from the Technical Publications Style Guide in normal PDF style. My task at Southwest was to take the style guide that had been written in Adobe FrameMaker and convert it line by line to ArborText. See Figure 9 below for what the cover looks like in the ArborText editing environment. As you can see, each piece of text and graphic is bound by its “tag.” By building documents in XML tagged format, the department is able to make sweeping changes to documents, automatically record exactly what those changes were, and update the document company-wide. For example, the fields circled in blue are the revision number and the publishing date. In XML, the author can change the information in that one place, and subsequently everywhere else that information appears will reflect the new values. What allows this to happen is the fact that the values are bound by XML tags. Everywhere those tags appear in a document will receive the updated information automatically. The idea of single sourcing is present here, where instead of building one manual at a time as you would in MS Word, once you have a certain type of manual built in XML, say an operator manual, you can easily build a completely new operator manual for a different end user because the operator information is the same from book to book.

Skills

  • Technical Writing/Editing

  • DITA

  • Interviewing Content Experts

  • Following a House Style Guide

  • Project Management

Tools

  • XML

  • Arbortext

  • DocZone/Oxygen/XMetal

  • DITA Content Management System

  • Windchill

  • Matrix

Previous
Previous

Insertable Cardiac Monitor Documentation Suite

Next
Next

Software for Medical Device