Skip to main content

v1.2

Minor Versionm

Approved General Content Updates

by Robert Sprankle

Introduction

Purpose

This guide provides the standards and best practices for markup in document conversions.

Overview

Markup makes your images clear and engaging. Use Dozuki markup tools to draw attention to specific areas of your images.

  1. Follow the Marker color pallet sequence, also known as ROYGBIV. Some images require flexibility with ROYGBIV.
    • Follow the Marker color pallet sequence, also known as ROYGBIV.

    • Some images require flexibility with ROYGBIV.

    • For example, an image taken under a red light does not lend itself to the use of red for the the markup.

    • In this image, green was used to provide a clear contrast that heightens the markup's value.

    • A contrasting color makes the markup tool visible.

    • Be consistent with your use of ROYGBIV. Changing the color sequence is limited to situations where the color(s) in an image dictate deviation for contrast and clarity.

    • Customer requests for CSS that includes color requirements is the only other time when ROYGBIV is altered or dismissed.

  2. Case Study Text to Markup Relationship: "Install the O-ring in between the collars on the post." Do not place markup broadly, indeterminately around the area that encompasses the part.
    • Case Study Text to Markup Relationship: "Install the O-ring in between the collars on the post."

    • Do not place markup broadly, indeterminately around the area that encompasses the part.

    • Instead, precisely target markup. Zero in on the target of the text.

    • Similarly, text in the QA section(s) of documents often refers to damage on a part or tool. In these cases, it is critical to place the markup tightly around the damage or defect shown in the image.

  3. Not all images require markup. If the subject in the image speaks for itself, do not use markup. In this example, the text simply referenced the fuel tank assembly and its part number. That's it. There were no instructions, defects identified, or individual parts of the assembly called out.
    • Not all images require markup. If the subject in the image speaks for itself, do not use markup.

    • In this example, the text simply referenced the fuel tank assembly and its part number. That's it. There were no instructions, defects identified, or individual parts of the assembly called out.

    • No markup should have been used.

    • Likewise, a picture of a tool which corresponds with text that only mentions the tool as an item should not be marked up.

    • However, a defect in the tool that the text is speaking to should be very tightly targeted in the markup (zeroed in on).

  4. Make sure your markup is focused on the text's object and/or emphasis. When the text refers to a particular part, orient the markup tightly and as "symmetrically, uniformly true" as possible around the part. Precisely target markup. Zero in on the target of the text.
    • Make sure your markup is focused on the text's object and/or emphasis.

    • When the text refers to a particular part, orient the markup tightly and as "symmetrically, uniformly true" as possible around the part.

    • Precisely target markup. Zero in on the target of the text.

    • Markup should be "tight/targeted", not loose/vague." It should be targeted on the object or emphasis of the text.

    • Do place markup broadly, indeterminately around the area that the part encompasses the part.

  5. In most instances, Do not "picture frame."
    • In most instances, Do not "picture frame."

    • Do not put markup around the the entire perimeter of the image. Only do this if the text is referring to the entire image, which may mean that the text is vague or more likely that markup is not needed.

    • Case Study Picture Frame Markup: "Inspect for quality issues and compare the connectors to parts currently being produced."

    • An Exception: You will likely need to "picture frame" an image when you need to add the color to connect an image to a particular bullet. Such cases are often work instruction callouts.

  6. Basic Guidelines for Markup Tools:
    • Basic Guidelines for Markup Tools:

    • Use the tool that best matches the shape of the object that needs markup.

    • Be precise with the markup so that it directly corresponds to the focus of the its text.

    • Markup is derived from the text. It is text-specific, text-focused.

    • Target the markup on the precise object of the text.

    • Do not apply markup "generally" or without a clear purpose.

    • If the text to image relationship does not require markup, leave it out.

  7. Use the circle tool for fasteners, cylindrical objects, buttons, and knobs.
    • Use the circle tool for fasteners, cylindrical objects, buttons, and knobs.

    • Make sure that the circle does not cover what you intend to highlight.

    • A common misuse of markup is using it too generally, in a manner that lacks focus on the text's emphasis.

  8. Make sure that the box does not cover what you intend to highlight. A common misuse of markup is using it too generally, in a manner that lacks focus on the text's emphasis. Use the box tool when a square or rectangular object is the focus of the text.
    • Make sure that the box does not cover what you intend to highlight.

    • A common misuse of markup is using it too generally, in a manner that lacks focus on the text's emphasis.

    • Use the box tool when a square or rectangular object is the focus of the text.

    • Sometimes the orientation of an object lends itself best to the box tool.

    • The box tool is also an effective choice for capturing text in an image.

  9. Use the gap and measurement tool when you have instructions that specify a gap in an image or call out a specific measurement.
    • Use the gap and measurement tool when you have instructions that specify a gap in an image or call out a specific measurement.

  10. Use the arrow tool to pinpoint the feature or focus of the instructions. Press the Start button.
    • Use the arrow tool to pinpoint the feature or focus of the instructions.

    • Press the Start button.

    • Support the tip with your finger.

    • Think of the arrow tool like an arrow, pointed, defined, precise, and on target.

    • Whenever it is possible, orient arrows vertically or horizontally. When an angle is required, use sharp angles that hone in on the "target" of the text.

    • Make sure that the arrow does not cover what you intend to pinpoint.

  11. The line tool can be used to show where parts must line up or how they are not aligned/uneven. The line tool is often used to represent where to cut something.
    • The line tool can be used to show where parts must line up or how they are not aligned/uneven.

    • The line tool is often used to represent where to cut something.

    • In some instances, it is used to outline an object or the levels of liquids, temperature, etc.

    • It can also be used to showcase a part or tool in an image, by underlining it.

Finish Line

Dozuki System

Member since: 09/24/2009

1 Reputation

176 Guides authored

0 Comments

Add Comment

TRUSTe