Documentation challenges and solutions

The following projects I worked on posed significant, specific challenges. In meeting those challenges, I not only created the required deliverables, but also produced lasting benefits in processes, and reusable content.

Two products, one deadline

The challenge
Two new products were being released at the same time. The documentation for these products needed to be written, reviewed, and translated in time for the release.
The solution
I developed, organized and managed the delivery of documentation for two different products at the same time, leveraging single-sourcing to create documentation for the two products from one file set.
The benefit
Single-sourcing this content improved consistency, usability, and time to delivery for the document set. A limited set of this documentation is available at:

  • http://publib.boulder.ibm.com/infocenter/mdm/v9r0/index.jsp
  • http://publib.boulder.ibm.com/infocenter/mih/v9r0/index.jsp

New standards for existing documentation

The challenge
An extensive set of documents needed to be converted to a new corporate documentation format and standard. This had to be accomplished in a very tight time frame in order to meet release dates.
The solution
I managed the conversion of a 1,000,000 word documentation set to DITA, and the revision of the content to the new corporate style, establishing and working to an aggressive schedule, ensuring that we met targets in order to translate and deliver the documentation in 11 languages.
The benefit
Converting the documentation set to DITA, and rigorously applying a style template ensured that the documentation could be easily maintained, translated, published in a variety of formats, and reused across documents.

Solving problems before they start

The challenge
Customers were having difficulty installing and configuring new products correctly, and needed direction on the planning and pre-work that needed to be done for a successful implementation.
The solution
I created a planning and implementation guide, intended for a non-technical business audience, that became a critical part of the documentation set for both business and technical users. This guide helped the critical decision-makers understand the products, their hardware and software requirements, and configuration needs.
The benefit
Several sets of users, from Sales, to potential customers, to users tasked with implementing the product, had a deeper understanding of the capabilities and requirements of a highly technical product.



Modify Website

© 2000 - 2017 powered by
Doteasy Web Hosting