Skip to content

Guide key

Introduction

The guidebook has been written to:

  • Inform and lead the reader to achieve a task or series of actions related to HCL Discover
    • Example, I need a tip how do do X, or can I do Y with this function
  • Focus it's content solely on achieving a goal, and not reference material.
    • Example, How do I use the solution as a business user? or How do I install the product?

The guidebook meets these needs by using a common approach to:

  1. Page styling / layout
  2. Typography (standard italics and bold, heading and tables)
  3. Iconography (those fun images)
  4. Visuals and interactivity

Page styling layout

Supported by Markdown, the guidebook uses the following to help the reader:

High-level category navigation at the top of every page for jumping between topics easily.

Simple and fast searching across all topics and content in the guidebook, click to jump to the content.

Clickable navigation to the right of the main content is built from the page headings used to format and structure the page, identify content relationships as you read.

Clickable content to the left of the main content is categorised around the topic of the page.

Iconography

Where possible the guidebook uses a common set of icons to identify relationships between similar or linked content and also product capabilities.

Typography

  1. Describing Functions / Actions Explaining a feature or an action the reader should perform. The guide uses bold for the name of the function when it's first introduced or when there is a need to emphasise it.

    • Example, The Hit Attribute Group allows to associated Hit Attributes together.

  2. Identifying an on-screen UI component. This includes button labels, menu items, field names, window titles, tab names, etc. The goal is to clearly distinguish these from the surrounding instructional text and the guide uses code font notation or bold.

    • Example, In the Settings window select the ...

Iconography

Side information is provided using call-outs, and serve to inform and ask the reader to take action where needed (see below). The call-outs are ways to distract the reading process to highlight content useful in the context of the task or topic.

Information

Blue

Information useful to the reader however not critical and no action needed.

Warning

Orange

Information that is key to the reader and care, an action or decision is

Tip

Turquoise

Additional information and advising of a linked action or useful step.

Success

Green

Informational and task focused. A task or series of steps completed. Can be followed by a suggested additional action.

Visuals

Where possible the guidebook used interactive visuals to help guide the reader through a task. This approach is engaging, quick and offers the option for feedback.