This case study describes how Applied Voice & Speech Technologies, Inc. (AVST) significantly streamlined its delivery of documentation and training materials with MadCap Flare.
Results of Case Study
AVST reduced documentation and training project time by 50% with MadCap Flare.
Using MadCap’s multi-channel publishing software, AVST no longer needs to use four applications to create the Administrator’s Guide, Online Help, and Training Guide.
Instead, Flare generates the content for all three AVST deliverables. The single-source publishing capabilities in Flare also have removed the need for AVST to purchase a content management system (CMS) costing tens of thousands of dollars more.
Aims of Case Study
"With MadCap, the output for all three deliverables is virtually flawless. Headings, the table of contents, cover page, and other elements all appear automatically without any manual manipulation after the fact," said Chris Sullivan, AVST director of training and documentation. "Moreover, because our content updates occur in a single project, rather than four separate projects, the resulting output is generated in just a few minutes – saving us hours of updates, edits, revisions, and formatting."
Reasons for Changing to MadCap Flare
For more than 25 years, AVST has produced a range of business communications applications, each of which requires administrator documentation, a training guide, and online Help system.
Prior to implementing Flare, Sullivan recalled, "It was tedious. Every time we had new information, we had to update the content fields in several applications. Compounding matters, some of our documentation was localized in 13 different languages, and those localizations had to be completed using these different applications. It was an extremely complex process."
"Now, by producing all three documentation deliverables in a single Flare project, we’re seeing immediate savings," Sullivan says. "We simply have reviewers provide their feedback in a Word document, and we incorporate the changes into Flare. Similarly, translations are now completed using a single Flare project. Not only are these processes faster, they’re also more accurate."
Cost Savings
AVST recently completed a cost savings analysis for producing single-sourced documentation with Flare.
- The Online Help, which provided the core content, took 190 hours to develop, review, revise and produce.
- Previously, completing the Administrator’s Guide and Administrator’s Training Guide would then require another 99.2 hours each (198.4 hours total).
- However, because AVST was able to repurpose 50 percent of the topics in Flare, the documents only took 8.3 hours each (16.6 hours total) to produce, resulting in a total savings of 181.8 hours.
With project-related labor costs averaging $50 per hour, AVST was able to save $9,088 producing one set of documentation.
The AVST analysis does not account for the added benefit of eliminating the need for a Content Management System (CMS), which would have added tens of thousands of dollars in license fees and hundreds of person-hours.
"The cost evaluation showed that our copies of MadCap Flare basically paid for themselves with just one set of single-sourced documentation," Sullivan said. "Equally important, our writers are achieving faster delivery to support the many tight turnaround situations we face each year."
Flare’s Most Valuable Features
Widely used features in Flare include variables and conditional tables of contents. Variables have significantly cut the time it takes to customize documentation for its OEM partner, changing all of the names in order to re-brand the materials. Meanwhile conditional tables of contents for topics mean AVST simply needs to hide topics that the company is not using for the print version or vice versa. AVST also makes extensive use of pop-ups to give readers the option of expanded in-line text.
Next Steps
AVST is now starting to use MadCap XEdit to further streamline the review process and keep all edits and comments in a single project. Following that, AVST also plans to implement the MadCap Team Server, which will facilitate collaboration among the company’s distributed team of writers.
Need help with your web writing? Click here for a Free Quote
Comments on this entry are closed.