|
Information
Developer's Toolkit
|
models | processes |
In this Article |
The meaning of a term, formally stated. The term may be a single word, or an expression with two or more words.
To provide readers with the precise meaning of a term. In some cases, readers don't know what the term means, and cannot understand a passage without your providing the definition.
In other instances, readers might be familiar with the term, but not with the specific meaning that you have for it. Some terms, for example, have several meanings. A definition clarifies the meaning you intend to use. Readers may only have a passing understanding of other terms, and the definition provides them with a much-needed reminder.
In other words, clarity in the use of terms is the cornerstone to clarity in all communication efforts. For instance, in the service industry (restaurants, hotels), you can set the expectations of customers by clearly defining what you mean by terms. If you state that a large burger weights 8 ounces before cooking, patrons have a reasonable idea of what size the burger should be when it arrives. In legal documents, defining terms in a contract clarifies the what one party agrees to provide and what another party can expect.
At the least, define all new technical terms introduced in the communication product, as well as common terms that have a unique meaning in the context of the technical information.
At the most, define all terms that readers might encounter but whose definition they might not remembered.
Pfeiffer (1995) identifies three types of definitions. Each type provides increasing levels of detail.
Example: The instructional designer, the person who plans and develops training courses, had responsibility for leading this meeting.
You might incorporate all three types of definitions into a technical communication product. You might include an in-sentence description so readers can continue reading without looking up a term, a glossary entry elsewhere in the communication product and an expanded definition where you describe the term in-depth.
Provide an in-text definition for each term the first time users encounter it. You do not need to repeat the definition in subsequent passages, if you can assume that readers have completed the earlier passages. (That is, if you are designing a website with several topics, you might define a term the first time it is used in each topic, because you cannot assume that readers have seen the previous topics.
For an expanded definition, include all of the components of a basic definition, as well as:
In the expanded defintion, place references to similar terms at the end of the expanded definition.
Of an In-text Definition:
the journal, a record of all changes made to the database,
Of a Basic Definition:
Journal: (noun) a record kept by the computer of all changes made to the database between the time the database is opened and the time it is closed.
Of an Expanded Definition
Journal: (noun) a record kept by the computer of all changes made to the database between the time the database is opened and the time it is closed.
If the system unexpectedly stops before you close the database file, the journal serves as a backup. The filename for a journal file is XXXXXXXX.jrn, where XXXXXXXX is the name of the database file that you were working on. The system automatically erases the journal when you close the database file. See also backup.
models | processes | techniques | resources on i.d. business and management | home
(c) Copyright. 1999, 2000, 2001, 2002. Saul Carliner. All rights reserved.