You start by defining something when you write a technical document. The definition needs to be clear about what the word means. Here are some things you can do while defining a word:
Putting a word into a category and setting it apart from other words in the same class is a simple way to start defining it. For example,
A "how-to" article is a type of "expository writing" that tells people how to do something in a clear and organized way.
The how-to article is a term, and the expository writing is a type.
You can also add extensions to make the meaning more clear. For example,
A how-to article is a type of expository writing that gives people information on how to do something in a specific way. Expository writing is a type of writing in which the writer's goal is to either tell the reader something or explain it.
"Expository writing" is a type of writing in which the writer wants to either give information or explain something to the reader. is a add-on.
If you want to define a word that has more than two meanings, you can use qualifiers. The qualifier is used when you need to set the general context right away. For example,
- "Bug" in computing means a mistake in code, a program, or a system.
- Bug (Biology): A bug is an insect.
In the case above, computing and biology are qualifiers.
As extra information:
Description of the process vs. description of the mechanism
A mechanism description tells you about the physical parts of a mechanism. A "process description" tells you how a mechanism works by listing all the steps or by focusing on how the parts work together. Both are different when it comes to the content they provide.
Keep writing. :)
Top comments (0)