Current Issue

Chapter News
Features
Viewpoints
Student Views
From the Editor's Desk
Message from the President
Reviews
Society Notes & Community Announcements




 Article Archives 

Book Review
Career Development
Case Studies
Content Management
Contracting & Consulting
Core Competencies
Meeting Reviews
Usability
Networking
Online Help & Embedded Assistance
Technologies
Translation and Localization
Up and Coming Corner
Information Architecture


 Past Issues 

May, 2012
April, 2012
March, 2012
February, 2012
December, 2011
November, 2011
October, 2011
September, 2011
August, 2011
June, 2011
April, 2011
February, 2011
January, 2011
August, 2010
July, 2010
June, 2010
May, 2010
April, 2010
March, 2010
February, 2010
January, 2010
December, 2009
November, 2009
October, 2009
September, 2009
July, 2009
June, 2009
May, 2009
April, 2009
March, 2009
February, 2009
December, 2008
October, 2008
September, 2008
May, 2008
April, 2008
February, 2008
January, 2008
November, 2007
September, 2007
August, 2007
April, 2007
March, 2007
January, 2007
November, 2006
October, 2006
September, 2006
August, 2006
March, 2006
February, 2006

Migrating Technical Authors to Structured Writing

Share on Facebook :: Printer Friendly Version

Josh Stubbs. Photographs by Marika Piehler.

Published: April 2011 in Meeting Reviews

The speed at which the authors embraced the new tools and methodologies was directly impacted by their understanding of the technology and what it could do.

Tamara Bailey is a senior technical communicator with extensive training and experience in usability, technical information management, and training. She is a former president of our chapter, and presently works as the Leader, Technical Communications at PMC-Sierra, a leading designer of semiconductors for the communications and enterprise storage industries.

On March 15, 2011, Tamara shared how her team transitioned several hundred technical content providers from authoring Microsoft Word documents to managing XML topics. This move enforced a more structured writing process—which allowed the company to take full advantage of a workplace where up to half of the workers were subject matters experts—and helped her team to seize opportunities for content reuse, as authors now had access to a library of existing information to supplement the work they wrote themselves.

The Technical Communications team at PMC-Sierra is small, consisting of her manager, two technical communicators, and an XML/Java system developer. Tamara pointed out that it would have been impossible to keep up with the writing of all original content, due to the sheer volume the company produced. The real value her team offered was found in developing the policies and processes surrounding the acquisition, development, management, and presentation of the information as an asset.

Managing the Transition

During this presentation, Tamara avoided preaching to the choir about the benefits of structured writing. Instead, she focused on the particular challenges her team faced with regards to training and coaching the subject matter experts at PMC-Sierra through the transition from Microsoft Word to XMLmind and Bluestream XDocs. The team saw that all change must be managed: While reusing existing content may prove to be more efficient, an organization must design robust systems and workflow in order to realize those benefits.

The model for managing this change was divided into five steps:

  • Analyze
  • Design
  • Develop
  • Implement
  • Evaluate

Author Collaboration

The speed at which the authors embraced the new tools and methodologies was directly impacted by their understanding of the technology and what it could do. Tamara used this to break down the users into various categories, especially the skeptics and early adopters. These workers could be placed in specific roles to assist, and sometimes even drive the process. For instance, the more skeptical workers could be used as testers, and the early adopters could provide new, creative ways to use the content. Her team waited for systems and processes to become more stable and concrete before introducing the more resistant users.

The ideas presented in Tamara’s presentation were useful, not only for the process of migrating to structured writing but in overall change management. Many times, I have observed team members present excellent ideas that were never made policy or practice because they were not able to create buy in. I also hate to say it but there were probably some good ideas that I personally passed on, simply because someone wasn’t able to get me to buy in either.

Tamara has kindly provided a PDF (2mb) of the presentation slides: stccwcpres_migrating_structmarch2011.pdf

You can read more of Josh Stubbs’ thoughts about Technical Writing at www.joshstubbs.com

Previous: Lightning Strikes Thrice: Three STC chapters present social media tools

Next: Incoming President’s Message


 Subscribe via RSS

Visit the main STC website.

STC advances the theory and practice of technical communication across all user abilities and all media.


STC-related links

Note: You may need to be logged into these services to view the pages.

©2012 STC CWC | Home | .(JavaScript must be enabled to view this email address)