Companies frequently come to Contiem looking to improve how they develop, deliver, and maintain their content.
A company may find that its documentation is not keeping pace with its end-users’ needs, or that the cost of developing and maintaining it is becoming an issue as the company grows. Such companies often need outside assistance from an experienced firm with the technical expertise to assess their specific needs and develop a corporate blueprint for content development and management. Contiem’s Consulting Services group works with our clients to develop an in-depth understanding of each organization’s needs and pain points. We then analyze the tools and processes currently in place for developing and maintaining content. This allows us to develop recommendations which, working with company management, are then used to develop a long-term content strategy, essentially a blueprint to effect the changes.
One client’s objectives
A company that manufactures complex, highly customized, software-intensive products approached Contiem about its need to significantly improve how product documentation was developed and delivered. The company was spending considerable time and money developing, printing, and distributing product manuals, yet they struggled to keep the documentation current with ongoing product releases. Users of the documentation complained that the manuals were not meeting their needs in several ways. The company knew it needed to move its documentation online to address some of its challenges, but had no path to accomplish this. All the while, the costs associated with supporting product documentation continue to increase, including the need to add staff and contractors. Having struggled with these issues for an extended period of time, they contacted Contiem for assistance, identifying three key business goals for product documentation:
- Be more accessible to customers and team members; printed manuals, hundreds of pages long, did not meet the needs of either customers or the company’s own service and support personnel.
- Shorten the time required to develop and update the documentation to get it current with the latest software and hardware releases.
- Reduce the costs associated with developing and updating content.
The Contiem approach
While every engagement is unique based on a company’s specific needs, Contiem has an established process for gaining the in-depth knowledge needed to develop content-strategic recommendations. These recommendations provide a blueprint to help companies achieve their documentation goals.
Establish the baseline
- Requirements for the audience and document deliverables. Contiem interviewed those groups that ‘touched’ the product documentation: Engineering, Software QA, Product Management, Marketing, IT, Field Service, Customer Support, and the Product Documentation team. This allowed us to identify each group’s needs and current pain points.
- Content analysis. Contiem then conducted a ‘deep-dive’ into a subset of the current product documentation, which allowed us to determine whether the documents fulfilled end-user needs and, if not, to identify the specific shortcomings.
- Documentation development process. Contiem examined how content was developed: the tools that were used, the processes for tracking and reviewing content, and how documentation fit into the processes used by other parts of the business.
- Documentation delivery format. Contiem uncovered how content (e.g., documents, updates) was made available to the various users (e.g., field engineers, customers).
Through this process, the Contiem team acquired in-depth knowledge of the current needs, processes, and pain points, providing a baseline for developing recommendations to implement the required improvements.
Identify the core issues
The Contiem experts rely on years of experience and best practices to sift through the baseline data and distill a list of the core issues. In this case, the key findings were:
- The manuals were very detailed and complete, but, at hundreds of pages, were too long; users had difficulty finding the specific information that they were looking for.
- There was too much introductory and explanatory information about the product that nobody used; this increased the cost of developing, printing, and maintaining the manuals.
- There were a number of features and sections that users rarely required; users were not reading the manual. Most customers were calling Customer Support when they had a problem.
- When the customers received onsite training, the trainer did not use the manual, so the customer was not familiar with locating information within the manual.
- There were a number of issues related to the processes being used by the product documentation team:
- Due to the tools and templates currently in use, considerable time was spent formatting the documents.
- There was no strategy for reusing repetitive content among the different documents or between products in a family.
- The processes were not aligned with the Agile process being used by the Software Engineering team.
- There was no process for managing the various priorities and requests that the Product Documentation team received, and there was no resource planning taking place.
Develop recommendations
After the in-depth analysis, Contiem developed a comprehensive set of recommendations to drive efficiency and achieve the company’s top objectives. The Contiem team leveraged their experience working with a wide variety of companies, applying best practices, and knowing what will drive the requisite unit cost improvements (e.g., cost per page). At a high level, the key recommendations were to:
- Reduce the amount of content being developed and maintained; rarely used documents should be archived or eliminated.
- Reduce the amount of content being printed; printed content should be in the form of checklists. The more detailed content, which will be used much less frequently, should be made available online.
- Accelerate the use of DITA, which will allow content to be more easily reused while reducing the time/cost associated with updating content. DITA will also greatly reduce the time spent formatting the printed manuals.
- Move documentation to HTML and web-based delivery, creating separate sites for customers and company support groups. (Note that for both the move to DITA and HTML and web-based delivery, Contiem provided specific recommendations for tools, processes, and priorities.)
- Implement a comprehensive structure for managing the priorities and workload of the product documentation team; align that structure with the current Agile-based process being used by Software Engineering.
The results
Contiem presented its recommendations to the company’s management team and held several review sessions to discuss them and the implementation path. After making adjustments, Contiem delivered a final report and implementation plan and began work shortly after. The approved recommendations were forecast to deliver significant annual savings. Print reduction accounted for 20% of the projected savings; the rest came from direct and indirect efficiencies. The process improvements reduced customer support calls, eliminated the need for additional contractors, and made much better use of the company’s subject matter experts. Beyond cost, the changes were designed to improve how customers perceive the company, get content to users faster, and reduce the management time spent on documentation.
Next steps
Contiem is in the business of easing our clients’ content challenges. The Contiem Consulting Services team is uniquely skilled at uncovering opportunities for improvement and providing an implementation blueprint. If you believe the way your documentation is developed, organized, synchronized, translated, delivered, or maintained could be improved, Contiem will work with you to tailor a solution to your specific needs. You can follow the implementation blueprint with in-house resources or choose Contiem as your complete content partner.
