Friday, August 10, 2007

Technical Writing

In creative writing, reality can be defined using any parameters in any pattern. In technical writing, reality results from the parameters. The greatest disservice done to software is the belief that the language describing and explaining its concepts has to be dry to be accurate, dull to be understandable. Software applications are better understood through careful, judicious use of rhetorical language: metaphors, similes, and mechanical techniques such as white space, bullets and intuitive graphics. Appealing to the user's figurative mind through language does not diminish his or her ability to grasp a complex concept.


To present complex ideas, we need quality communication. Software drives much of our businesses, yet what makes an application stand out from the many? Ease of use.
Software must be used before an ROI is realized. Training, guides, and references are the gateways to understanding and appreciating software. A well-written manual makes a software product more user-friendly, and saves technical support time. Crafted training opens software potential. Documentation and training are silent sale representatives.


The writer’s job through training and documentation is to make the client successful. The writer’s work is more than documenting or explaining, it is collaboration between people - an interdisciplinary approach. The writer must be mindful of the perspectives of each contributor, and inspire him or her to give the best information possible for the benefit of the user.


Technical writers best represent their companies as customer advocates and skilled translators.



Ron Milos
Techncial Writer
Documentation Strategies

0 comments: