This chapter is used in the following
This chapter is intended for the casual, normal and expert
Several products provide user interface based on
a dedicated hardware device with physical buttons and levers. The
visual presentation offered by the product may be small or non-existent.
This chapter provides a detailed overview of this hardware device,
how the buttons are organized, and the purpose of each of them.
Note: The name of the chapter must reflect the name of the hardware
Which chapter title 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
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
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
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
Chapter structure and section titles
sections are used. In order to provide consistent documentation, the
sections in this chapter must use the names listed, and in this specific
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.
Recommended structure for the topics in this
Each topic is normally provided in a separate section.
End user manuals