Posted in Technical Documentation

Technical documentation conversion projects, often a failure!

The writing style matters the most while converting a doc/pdf document to the Web. Mostly, such projects are published online with a publishing tool that converts the documents into HTML and CHM help files (exact copies). This is the easiest form of conversion but a total disaster in terms of language consistency, voice, style, and formats. The strength of online help lies in information mapping. It’s nothing but creating relevant topics/content that can be linked for easy navigation. This is one of the effective ways to control redundancy. Task-based documentation must be the primary goal while writing for the web. Writers often get carried away focusing on the new publishing tool leaving the content unchanged.

 It is highly recommended for a writer to rewrite the content in such a way that it adheres to the company standards and Web Content Accessibility Guidelines . During the conversion process, one may get tempted to overlook the standards required for the web as it needs time, patience.

Author:

I shall be telling this with a sigh Somewhere ages and ages hence: Two roads diverged in a wood, and I— I took the one less traveled by, And that has made all the difference. BY ROBERT FROST

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s