Not all technical documentation projects are the same. Make sure your budget is consistent with your expectations and with the realities of your documentation services project. As with many other things in business and life, you get what you pay for. There is a large difference between simply revising a mature document for an interim product release and building a new set of product documentation. Similarly, graphics‐intensive documents that require numerous review cycles, or documents for which source material is difficult to obtain, obviously require a greater investment.
Product documentation should be integrated into the product development cycle from the beginning. It is not unusual for companies to spend time and effort on internal documentation – such as product requirements, specifications and engineering change notices – and to delay producing customer and user documentation so long that the product release date is jeopardized.
High‐quality product documentation relies on the participation of the in‐house staff with expert knowledge. They must actively participate with the technical documentation services vendor in the collection, review, and approval of technical details. No technical writer or technical documentation services firm, regardless of how good they are, can compensate for lack of participation and buy‐in from the Subject Matter Experts.
Assuming your technical documentation services outsourcing provider has the exact IT infrastructure needed to run, test, and document your product is a risky assumption. Anticipate what is needed to replicate your product environment, whether high‐tech or low‐tech, and build those considerations into the planning.
Meeting deadlines requires everyone’s participation, and outsourcing technical documentation services does not eliminate the need for timely reviews and approvals. Make sure your documentation plan spells out the specific responsibilities of each reviewer. When you delegate final approval authority to the technical documentation services vendor, clearly define the criteria for acceptance of the technical document.
The vendor’s technical documentation services outsourcing team provides an extension of your company’s capabilities. As such, there may be overlapping roles for which you assign final responsibility. For example, is the final document QA completed by the vendor or by in‐house resources?
Ignoring technical documentation translation can save some time and money early in the technical document development cycle but, inevitably, results in much higher costs later. Content intended for multiple global markets requires a specialized approach to writing, illustration, and formatting that can add time to the front end of the project. However, these costs are quickly recovered during the translation phase.
Technical documentation is most efficient and cost‐effective when it is designed to meet the needs of the target audience. Know the reading level, technical sophistication, and usage preferences of your document’s audience. It is also critical to understand what the audience needs to know, versus what is non‐essential, so that you don’t waste time and cost developing and maintaining unnecessary information.
An effective outsourcing organization requires an infrastructure that can scale to meet department and company needs. Look for evidence of mature accounting, operations, IT, and project management and a track record of success.
Complex technical documentation projects usually have numerous milestones with various dependencies that make project management expertise essential. Make certain your technical documentation services provider can supply that expertise.
Since 1994, InfoPros has proven its documentation and training expertise with a commitment to best‐in‐class services and client‐centered solutions. Experienced in a host of authoring software and with a wide variety of industries, we specialize in delivering a blend of services for documenting products and processes, training development, and translation and localization.
Whether you need a complete training program to augment a new product or service, or you require job aids for internal learning, InfoPros has the experience and skills to deliver the results you are looking for. By combining a client-centric focus with our structured three-step approach, we are able to design a customized solution that will fit within your business.