Style Guides: Fashionable But Also Practical

Having problems with inconsistently written documentation? Do your user manuals need some help themselves? If so, then you need a style guide for your technical writing team. We’re not talking about what they should wear, but how they should write.

Content couturier Keith Schengili-Roberts (IXIASOFT) talks about what they are, why you need them and how to use them effectively. While not exclusively focusing on DITA, Keith will also talk about why a style guide is a necessity for any team working with DITA.

Continue reading “Style Guides: Fashionable But Also Practical”

How to use root-cause analysis to promote information supply chain methodologies

If your documentation process is implicated in a customer quality incident (CQI), Congratulations! You have the platform needed to shine a light on the problems you’ve been escalating for years.

In this presentation, Seth Park will argue that errors in documentation are actually symptoms of underlying data flow issues. If you don’t get involved in root-cause analysis, you’ll end up being asked for more reviews and checklists when you really need a more effective method for transferring data amongst teams. Continue reading “How to use root-cause analysis to promote information supply chain methodologies”

Using Controlled Language to Improve Reuse and Global Readiness

Mindful and enlightened TCs working in a CMS environment maximize re-use and create global-ready content that meets their audiences’ needs while reducing costs and improving efficiency. Controlled Language, implemented correctly, can help you achieve these goals. However, many companies implement Simplified Technical English or other controlled language initiatives, but struggle to maximize the benefits, or discover issues with the human side of change management. In this presentation, we will discuss best practices for implementing controlled language, identify some potential challenges, provide recommendations for working around them.

After the presentation, participants will have a better understanding of these concepts:

  • Best practices for implementing controlled language
  • Risk mitigation and the importance of pilot projects
  • Effect of implementing controlled language on your TMs
  • Benefits and ROI of controlled language

TC Dojo Master

Kit Brown-Hoekstra, Comgenesis, is an STC Fellow and STC Society Immediate Past President. She’s an experienced consultant with over 25 years of experience in technical communication, much of it working with localization teams. As Principal of Comgenesis, Kit provides consulting and training to her clients on a variety of topics, including localization, content strategy, and content management. She speaks at conferences worldwide and publishes regularly in industry magazines. Her blog is www.pangaeapapers.com.

Watch the Video

View the Slides