Home> About us > Branding guidelines > Documents > Manufacturing documents >

Chapter specification - Display views

This chapter is intended for the casual, normal and expert operators.

On any product offering visual presentations – echo sounders, sonars, dynamic positioning systems etc – the display presentation is normally a mixture of graphic images (frequently providing information using various operational modes), toolbars, title bars, task bars, status bars and menus. It is important that all readers understand what kind of visual information is found where, and the functionality provided by each visual entity.

This chapter provides a detailed overview of the visual information displayed by the product, and how this information is organized. It thus presents the graphic views, operational modes, and all the icons and buttons used in the presentation entities. The chapter also provides a short introduction to the menu system, but refers to the dedicated Menu system chapter for detailed information about the choices provided.

Which chapter to choose

You can choose between three different chapter titles to describe the interaction between the user and the product.

  • Display views – the product offers a highly specialized visual presentation, but no dedicated operator panel. The product may use a standard computer keyboard and a mouse, but these items are not explained.

    The chapter thus describes what the user is seeing .

    Typical example products are sonars, echo sounders and catch monitoring systems.

  • Operator panel – the product offers a dedicated keyboard, operator panel, button panel etc, but none or only a very small visual presentation.

    The chapter thus describes what the user is using.

    Typical example products are AutoChief C20 propulsion control systems, Bearing Wear condition monitoring systems, Bridge Watch monitoring systems etc.

  • User interface – the product offers a combination of a dedicated keyboard, operator panel, button panel etc and a more or less a highly specialized visual presentation.

    The chapter thus describes what the user is both seeing and using.

    In some cases the User interface chapter may therefore include Display views and Operator panel as two sections.

    Typical example products are K-Chief 600 automation systems, K-Gauge level gauging systems etc.

Terminology

Whenever a graphic user interface is described, we must always use the rules and guidelines defined by the Microsoft Manual of Style.

Chapter structure and section titles

The following sections are used. In order to provide consistent documentation, the sections in this chapter must use the names listed, and in this specific order.

  1. Display organization

    This section offers an overview of the visual elements provided by the product.

  2. Operational modes (If applicable)

    This section offers a description of the operational modes provided by the product. References are made to a dedicated chapter if the operational modes are complicated and/or in need of in-depth descriptions.

  3. Title Bar (If applicable)

    This section provides a detailed description of the Title Bar (top line in the display presentation). The description must include all icons and buttons. If required, references are made to operational procedures and/or relevant reference information.

  4. Status Bar (If applicable)

    This section provides a detailed description of the Status Bar (bottom line in the display presentation). The description must include all icons and buttons. If required, references are made to operational procedures and/or relevant reference information.

  5. Toolbar (If applicable)

    This section provides a detailed description of the Toolbar. The description must include all icons and buttons. If required, references are made to operational procedures and/or relevant reference information.

  6. Menu system (If applicable)

    This section provides a description of the menu system, but it does not describe the commands provided. References are made to the dedicated Menu system chapter.

Topic structure

Structured topics are essential to create modular documentation. By breaking down the information to easily recognizable elements that comply to a defined structure, the elements are easier to locate and reuse in other sections, chapters or books. Makes sure that file names reflect the elements position in the structure.

Each topic is normally provided in a separate section.

Recommended structure for the topics in this chapter are:

  1. Where to find the visual entity

    The physical location of bar, button, icon, presentation view etc.

  2. Screen capture

  3. The purpose of the visual entity

    Assuming the element is there for a reason, as a button, icon etc.

  4. Description of the visual entity (May be split into more than one element file)

  5. Admonitions (If applicable)

  6. Related topics (If applicable)

Topics

Back to