Previous Next Functional Tool Requirements Homepage  
3.3 Service Complex: User Interface  
SUI03 - Help Functions  

  LNSS03 - Hilfefunktionen

Contents  
  • 1 Allocation to V-Model and Methods Allocation
  • 2 Brief Characteristics
  • 3 Requirements
  •       3.1 Requirements for Interfaces
  •       3.2 Requirements for the Methods Support
  •       3.3 Requirements for Functions
  •       3.4 Other Requirements

    • 1 Allocation to V-Model and Methods Allocation

    not applicable

    2 Brief Characteristics

    This service unit defines the requirements for tools with regard to help functions in interactive processing (on-line). Furthermore, this service unit defines the requirements for tools with regard to the documentation.

    3 Requirements

    3.1 Requirements for Interfaces

    none

    3.2 Requirements for the Methods Support

    none

    3.3 Requirements for Functions

    SUI03.F.1 Help functions
    SUI03.F.1.1 Selection of help text It is possible to request help text for the functions of the tool.
    SUI03.F.1.2 Help about help It is possible to request a help text about the call and use of the help function.
    SUI03.F.1.3 Keyboard assignment It is possible to display the current keyboard assignment. This includes the assignment of the function keys and of the key combinations (e. g. Control, Esc).
    SUI03.F.1.4 Context-sensitive The help function is context-sensitive.
    The offered help text depends on the operation just processed and on the actual position held in the application.
    SUI03.F.1.5 Further help It is possible to request further help for certain key words in a help text.
    These key words are specially marked, e. g. they have a colored background.
    SUI03.F.1.6 Last error message It is possible to request help for the last error message.
    SUI03.F.1.7 Help via index It is possible to request help via an alphabetically sorted list of key words.
    SUI03.F.1.8 Degree of help It is possible to change the degree of help offered during a session.
    It is possible, to choose between the degrees "short", "medium" and "long". A first-time user of the tool will select the "long" help text, an experienced user will probably select the "short" help text.
    SUI03.F.1.9 Individual help texts It is possible to integrate individually generated help texts into the tool.
    This is helpful if self-generated functions can also be integrated into the tool.
    SUI03.F.2 Help display
    SUI03.F.2.1 Switch It is possible to switch between help window and application.
    SUI03.F.2.2 Simultaneous display It is possible to display help windows and application simultaneously.
    SUI03.F.2.3 Several help windows It is possible to display several help windows simultaneously.
    SUI03.F.3 Printing help text It is possible to print out help text.
    SUI03.F.4 Documentation
    SUI03.F.4.1 Table of contents The documentation includes a table of contents.
    SUI03.F.4.2 Installation instructions The documentation includes installation instructions.
    SUI03.F.4.3 Introduction The documentation includes an introduction for first-time users.
    SUI03.F.4.4 Brief reference The documentation includes a brief reference.
    This reference gives an overview of the most important functions and the corresponding parameters. It must be easy to handle (e. g. as a folder) and to be placed next to the keyboard.
    SUI03.F.4.5 Functionality The documentation completely describes the functionality of the tool.
    Detailed examples should be available for the individual functions.
    SUI03.F.4.6 Messages The documentation includes a complete list of the messages, the corresponding causes of the errors, and the recommended correction measures.
    This list should differentiate between different message types (alarms, errors, etc.) and, within these categories, this list should be in alphabetical order or sorted according to error keys.
    SUI03.F.4.7 Special features The documentation contains a list of the special features dependent on the implementation.
    This also includes the limitations dependent on the implementation (e. g. maximum number of lines in a file that can be processed with an editor).
    SUI03.F.4.8 Compatibility The documentation comprises information about the upward and downward compatibility between tools releases.
    SUI03.F.4.10 Glossary The documentation contains a global glossary.
    In the case of a large documentation consisting of several volumes, the global glossary refers to the page in the corresponding volume. This simplifies direct access considerably.
    SUI03.F.4.11 Correct tool version The documentation refers to the right version of the documented tool.

    3.4 Other Requirements

    SUI03.O.1 Comprehensibility Help texts are understandable and comprehensible.
    SUI03.O.2 Language It is possible to formulate the message texts in a way matching the corresponding linguistic environment.
    SUI03.O.3 Examples The help texts include examples.

    Previous Next GDPA Online Last Updated 01.Jan.2002 Updated by Webmaster Last Revised 01.Jan.2002 Revised by Webmaster