Just like the previous blog posts on definitions, it is important to include technical descriptions, specifications, and marketing materials in your technical document. A description is a picture with words and images, but a technical description conveys knowledge about a product's operation that will eventually contribute to its use, operation, assembly, and manufacture. An image can be visualized from a multitude of perspectives, so much your consider your audience and your purpose when constructing your description of something.
There are two types of technical descriptions: product descriptions and process descriptions. When someone wants to learn how to use a device, they will refer to a product description. And when someone wants to understand the steps behind a complex event, they rely upon a process description.
A description can either be subjective or objective, but, with the excuse of marketing material, your descriptions must be objective. Objectivity, of course, is based solely on facts. In order to remain objective, try to stick to details that are visual and not emotional. Also, use precise and informative language; however, don't confuse precise language with complicated technical terms.
Usable descriptions will have the same string of elements included. First, the title should be clear and limiting, giving an immediate forecast. Also, the description must have the appropriate level of detail and technicality; this means you must consider how technical your audience is. You should only give the readers exactly what they need. Visuals are also necessary, and they should repeat, restate or reinforce your description. All of your drawings, diagrams, or photographs should have appropriate captions and labels, too. Your description will also have a clear sequence of events that should be organized based on your reader's understanding. A spatial sequence will parallel the reader's angle of vision, and describe the process accordingly. Functional sequencing is best when describing a given mechanism in action, and it parallels the order in which parts operate. Chronological sequencing parallels the order in which parts are assembled, and its best for visualizing terms in order of assembly.
A complicated description will almost always have an outline; the following components are usually concluded in a typical descriptive outline. The introduction will provide readers with only what they need to know to get the general picture. This could include a definition and function, history and background, purpose and audience, principle operation, major parts, and a visual that reinforces what you just stated. Next, the body section will describe each major part in greater detail. This includes the definition, size, shape and material of the part, and its subparts. Also, the function and relation of the part to adjoining parts should be included, in addition to a mode of attachment to the overall device. Finally, a summary will show how parts interrelate, and also complete one operating cycle.
Specifications provide standards for performance, safety, and quality-- they describe products and processes. They are often used for complying with safety codes, meeting an engineering standard, or appealing to a government or legal ruling. Specifications also address a diverse audience, including: your customer, the designer, the contractor or manufacturer, the supplier, the workforce, and the inspectors.
Technical marketing materials are geared to sell products or services, and they usually differ greatly from specifications and descriptions-- they're more colorful and less formal. Technical marketing can be used in a variety of mediums, including: web pages, brochures, fact sheets, letters, and large color documents.
Group Discussion Question: What types of devices need specifications? Does every product need them?
No comments:
Post a Comment