Sign in or Sign up!

 

 
September 15, 2011
Updated: May 22nd, 2013 12:47 PM (MT)

Mastering Product Documentation in a Wiki

Speaker: Amalia Hurtado

Using a wiki platform to create product documentation can promote collaboration among technical communicators and developers. Spatial Corp. has several development sites around the world, and a new system was needed to reduce the backlog of new content/change requests and the amount of time between doc freeze and product release. For years, Spatial used tools such as RoboHelp, FrameMaker, WebWorks Publisher, Sharepoint, and raw HTML; all had some advantages, but none allowed the immediate access and collaborative atmosphere that a wiki could provide.

In this program, Amalia Hurtado, Technical Publications Manager of Spatial Corp., will explain the company's move four years ago to using a wiki platform. She'll discuss getting the buy-in from all members, transitioning 7,000+ technical articles and 5,000+ images, and what you and your customers need to know before embarking on this move. She will also reveal the pros and cons for using a wiki so that you can determine if this platform is right for your company. During the presentation, she will show examples of their internal controls for managing doc bugs, linking to the 20,000+ pages of library reference documentation (generated by Doxygen), viewing a custom dashboard to illustrate how they keep track of pages needing attention, and their "Gold Seal Standard" for motivating developers to "own" and improve technical articles that document their areas of expertise.

Amalia encourages an interactive presentation; please feel free to bring your questions and join us for a lively discussion.