
An established software provider had developed extensive documentation for their users.
However, the documentation, in a hard copy version, had not been updated for over three years.
In addition, there were users’ complaints on the lack of ease and applicability in using the documentation.
The client needed a plan to provide the documentation in an on-line (soft copy) solution and to update and enhance their existing documentation.

evaluated the client’s business needs to determine which documentation approach
would most effectively support the client’s overall objectives.
assessed their existing documentation to determine where there were inadequacies.
researched alternative
on-line solutions, including
software tools to assist with the documentation development.

- A more relevant documentation methodology was established which was both
more user-friendly and more inclusive of the user’s needs.
- A plan was created for the implementation of the rewrite that included the new approach.
- A software tool was selected to assist with a web-enabled HTML approach for their end product.
- Templates and standards were developed to assist the Writers in their documentation development.