Skip to main content
Authoring

The foundation for any good manual is clear and effective step-by-step documentation. This means that the documentation presented is both easy to understand and develop. Our guide creation tools make it easy to write and edit guides.

15 Questions View all
Discussion Topic
User avatar

Markup and Bullets Best Practices

Dozuki’s dynamic bullets allow more clarity in the way images and text can interact with each other within a guide step.

Color coding the markups on the image to correlate to the bullets in the text allows authors to tie multiple text instructions to images without causing confusion to the reader.

The best practice would be to establish a company standard for color order that all authors will follow to increase standardization. As a company, Dozuki follows the ROYGBIV order of colors.

Examples

The image below is an example of using colored bullets to attach 3 unique pieces of text to a single image:

Block Image

The two images below are an example of using colored bullets to illustrate which line of instruction relates to which image inside a single guide step:

Block Image


Block Image

Special Bullets

Colors are not the only option for bullets in a Dozuki guide. There are also three special bullet options:

Block Image

These are used most effectively with an indent so that they are not mistaken for a step in the process. Here’s an example of an indented ‘note’ below:

Block Image

The ‘note’ and ‘reminder’ bullets behave the same as colored bullets aside from their look. The ‘Caution’ bullet, however, has a unique behavior. Any text associated with a ‘Caution’ bullet will turn red once the edit is saved as seen in the example below:

Block Image


How do you use dynamic bullets in your own guides?

Reply to discussion Subscribe to discussion

Is this a worthwhile discussion?

Score 3
Add a comment

1 Reply

User avatar

This is good - but using colors to differentiate markups is difficult for colorblind users. Further, my company wants to use colors to differentiate between Hazard (red), Safety (red), Quality (blue) items.

An improvement would be to add alpha (a-h) or numbers (i.e. 1 through 9) into the markup so each box could be associated with a numbered Task.

Was this reply helpful?

Score 0
Add a comment

Join the discussion

Author avatar Michael Rans will be eternally grateful.
TRUSTe