purpose header
LRA Logo

home

about us

web design

technical
documentation

productivity
management

portfolio

contact us

site map

Level Level 2

Note: Meets CSS Level 3. W3C has not released the full specification for this level.

Valid HTML 4.01 Transitional

Note: To be updated to meet W3C HTML 5.0 when 5.0 is released - late 2010 or early 2011.

PURPOSE OF TECHNICAL WRITING

Documentation has a main purpose of linking ideas, technologies, processes, and products with people who need to understand or use the products in an "audience-friendly" way. The purpose has three elements:

FORM answers the question, What is it? The reader must have a complete description of the object (process, idea, or concept) and the document conveys this message in concise, "audience-friendly" language.

FIT is nothing more than a description about the object. For example, the reader needs to understand the method(s) behind the object: how it is assembled or installed or used.

FUNCTION, probably the most difficult of the three, is the "How to" section. All of the object's features, functions, and, yes, even shortcomings, are described. Each is completely illustrated and discussed in accordance to the intended users' skill level.