Introduction
This guide provides the standards and best practices for using bullets in document conversions.
-
-
We use typographic conventions to communicate relationships between text elements.
-
For Example: Often, bullet characters denote each item in a list of words, phrases, or paragraphs. The bullets communicate that the list items are related.
-
The bullets identify the items as relevant details for the text preceding the list.
-
It is a common practice to utilize a hierarchical structure for ordering related text.
-
-
-
Use the left and right instruction arrows to order related subordinate text beneath the main text. This includes all forms of content (instruction, supplemental information, reminder information, etc.).
-
Common terms for the instruction arrows are indent bullet or subset bullet.
-
The arrows provide two levels of subordination.
-
-
-
The black "instruction" bullets are the default bullet in a Dozuki guide.
-
"Instruction" bullets refer to a specific instruction or command.
-
For example: "remove the screw" or "apply pressure."
-
While bullets are black by default, their color can be changed to match the markup on images.
-
Do not use color bullets without a corresponding markup. This makes things very confusing!
-
Non-action instructions (like "stand by" or "watch") are still actions, even though they require no movement.
-
For information pertaining to the use of color bullets for markup, refer to the Document Conversion Markup guide.
-
-
-
Note ("info") bullets provide important supplemental and/or contextual information about a specific step or action.
-
Use the note bullet to provide additional context, such as an example, about the process; it's information that does not work as a standard instructional bullet.
-
For Example: "The finished product should have no cracks or irregularities."
-
Another use for the note bullet is to refer to supplemental material outside of the guide.
-
-
-
Work instructions are often accompanied by information that does not explain processes or give direct how-to commands.
-
Instead of using an info bullet for every individual piece of information, use regular black bullets for points or steps in the process.
-
Info bullets are best reserved for contextual information that relates to the process, but they are not for process commands.
-
"Carry the spacers to the next station" is an instruction.
-
"The spacers are placed at intervals to align the product" is an note/info bullet.
-
-
-
Reminder bullets are important information or parts of the process that require extra attention before going to the next step.
-
Reminders are most often used when the process requires a check or verification.
-
As a general rule, watch for "sure" words and phrases: "be sure," "make sure," "ensure," etc.
-
PPE is often a reminder bullet, unless the potential risk is serious enough to merit a caution bullet.
-
"Ensure that you are wearing proper footwear and eye protection."
-
"Caution! Do not open the safety during saw operation."
-
-
-
In general, Reminder bullets are like "mild" caution bullets: they are necessary for understanding and completing the process, just without the serious risk that a caution bullet denotes.
-
For example, if you were telling your operator to put on gloves before sweeping with a broom, a reminder could warn them about potential blisters.
-
If your operator is handling liquid nitrogen, use a caution bullet. You want to make certain they're wearing those gloves.
-
-
-
Caution bullets are attention-grabbing bullets that should be used when there is a serious risk to the operator, equipment, or the product.
-
Most often, caution bullets are used in instructions that have a risk of bodily harm.
-
-
-
Even in processes that don't involve harm to people or equipment, caution bullets still point out actions and circumstances to avoid.
-
Caution bullets can point out serious interruptions or breaks to the process.
-
For example, if an action in a software or interface is irreversible, a caution bullet would stand out as something the operator must avoid.
-
Our Help guides occasionally use the caution bullet to make important points and strong reminders on how to avoid certain pitfalls.
-
Use caution bullets sparingly! They're only effective if they stand out, and they only stand out when they are used judiciously.
-
-
-
The criteria outlined in this guide for when to use which type of bullet is based on Dozuki's best practices, but not a one-size-fits-all for all work instructions.
-
Sometimes a guide may be comprised entirely of information with no direct instructions.
-
In this case, the default black bullet would still be used for the bulk of the content, with info bullets being reserved for references to external content.
-
Many quality and inspection WIs are made up of actions involving "check," "verify," "ensure," etc., which are some of our criteria for implementing reminder bullets.
-
In this instance, the reminders would be treated as actions, with the reminder bullet being used sparingly for information important to the process.
-
Don't feel the need to forcibly include special bullets. They work best when they stand out, and they stand out best when used sparingly.
-
Cancel: I did not complete this guide.
One other person completed this guide.