Podcast -- Tackling Godzilla: A Writer/Usability Consultant Reflects on the Largest Project of her Career
In this podcast, I talk with Theresa Putkey, a writer/usability consultant in Vancouver, about the largest project of her career. She explains how she approached a project that had upwards of 2,500 help topics, many of which consisted of duplicate content. She explains how she transitioned from RoboHelp to Flare, the advantages she found as well as her regrets, and how she configured the search to make it easy for users to find information.
Theresa recently presented a similar topic at Content Convergence and Integration, a conference in Vancouver. Her presentation was titled "SuperWoman, WonderWoman, UnderDog, and Leprechaun, with Flare: A case study in breaking down silos." You can view the slides from her presentation on SlideShare.
Topics Covered in the Podcast
Topics covered in this podcast include the following:
- approaching large projects with hundreds of help topics located in multiple sources
- how Flare and RoboHelp handle large projects (latency issues)
- AuthorIT, always a hometown favorite
- techniques for breaking down silos
- how she transitioned from technical communicator to information architect
- why she moved away from RoboHelp to Flare, and the problems she found with both
- the sluggishness she encountered with large files
- how to approach the information architecture for a project with 2,500+ topics
- tips for creating more effective searches
- implementing Madcap Feedback server for keyword search metrics and and comments/feedback
- overcoming problems of findability
- integrating knowledge base articles with read-me's and technical guides and user guides maintained in 5 different formats
- creating a master search for a massive help project
- topic-based browsing in the TOC versus search
- configuring synonyms and keyword concepts
- limitations with Flare's search
- techniques for gathering feedback from users
- importing Word files into Flare
- cleaning up RoboHelp code before importing into Flare
- getting buy-in from different departments (teambuilding)
- Flare's unexpected learning curve
- choosing software based on the needs of your project
- considering cost when selecting software
- several hidden gotchas in Flare
- working with concept keywords in Flare to improve the searchability
MadCap Flare is the most versatile XML-based Help authoring tool on the market, with thousands of customers using MadCap products including Microsoft, Google, HP, GE, yahoo and the list goes on. Check out Flare version 3.1 and a host of other new tools at at madcapsoftware.com.
Adobe – The Technical Communication Suite software offers a complete solution for authoring, managing, and publishing interactive instructional information from technical documents and books to online help systems, knowledge bases, interactive training, and eLearning content in multiple formats and languages. Learn more here.
Intro music is Velveture by Ocean Alexander
Upcoming Training on WordPress
Are you interested in learning more about self-hosted WordPress blog sites? If so, let me know by sending me an email ([email protected]). I'm planning to offer some training in the upcoming weeks. Training will cover everything from the basics, such as using posts, pages, categories, and tags, to PHP calls and CSS tweaks.
About Tom Johnson
I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.
If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.