|
IEC TR 63183
Edition 1.0 2019-12
TECHNICAL
REPORT
colour
inside
Guidance on error and warning messages for software used in radiotherapy
your local IEC member National Committee for further information.
IEC Central Office Tel.: +41 22 919 02 11
3, rue de
CH-1211 Geneva 20
Switzerland
About the IEC
The International Electrotechnical Commission (IEC) is the leading global organization that prepares and publishes
International Standards for all electrical, electronic and related technologies.
About IEC publications
The technical content of IEC publications is kept under constant review by the IEC. Please make sure that you have the
latest edition, a corrigendum or an amendment might have been published.
IEC publications search - webstore.iec.ch/advsearchform Electropedia - www.electropedia.org
The advanced search enables to find IEC publications by a The world's leading online dictionary on electrotechnology,
variety of criteria (reference number, text, technical containing more than 22 000 terminological entries in English
committee,…). It also gives information on projects, replaced and French, with equivalent terms in 16 additional languages.
and withdrawn publications. Also known as the International Electrotechnical Vocabulary
(IEV) online.
IEC Just Published - webstore.iec.ch/justpublished
Stay up to date on all new IEC publications. Just Published IEC Glossary - std.iec.ch/glossary
details all new publications released. Available online and 67 000 electrotechnical terminology entries in English and
once a month by email. French extracted from the Terms and Definitions clause of
IEC publications issued since 2002. Some entries have been
IEC Customer Service Centre - webstore.iec.ch/csc collected from earlier publications of IEC TC 37, 77, 86 and
If you wish to give us your feedback on this publication or CISPR.
need further assistance, please contact the Customer Service
.
IEC TR 63183
Edition 1.0 2019-12
TECHNICAL
REPORT
colour
inside
Guidance on error and warning messages for software used in radiotherapy
INTERNATIONAL
ELECTROTECHNICAL
COMMISSION
ICS 11.040.60 ISBN 978-2-8322-7715-7
– 2 – IEC TR 63183:2019 © IEC 2019
CONTENTS
FOREWORD . 4
INTRODUCTION . 6
1 Scope . 7
2 Normative references . 7
3 Terms and definitions . 8
4 General guidance . 8
5 Designing error message displays . 8
5.1 Design systems to avoid the errors in the first place . 8
5.2 Categorize messages . 8
5.3 Consolidate reports and displayed error messages . 9
5.4 Summary of main concepts . 9
6 Message content usability guidelines . 10
6.1 Basic structure . 10
6.2 OPERATOR centred . 10
6.3 Message clarity . 10
6.4 Message action ability . 12
6.5 Conciseness . 12
6.6 Message specificity . 12
6.7 Courteous . 13
6.8 Use of error codes . 13
7 Guidelines for the development process . 13
8 Visual design guidelines . 14
(informative) Checklist . 15
(informative) Examples . 16
Bibliography . 23
Index of defined terms . 24
Figure 1 – Example error message answering what happened, why and what to fix . 10
Figure 2 – Example error message with unclear language on how to proceed . 11
Figure 3 – Example error message with unfamiliar OPERATOR abbreviations . 11
Figure 4 – Example error message implying the system thinks . 11
Figure 5 – Example of an unhelpful error message . 12
Figure 6 – Example error message showing error code . 13
Figure B.1 – Example 1. 16
Figure B.2 – Example 2. 16
Figure B.3 – Example 3. 17
Figure B.4 – Example 4. 17
Figure B.5 – Example 5. 17
Figure B.6 – Example 6. 18
Figure B.7 – Example 7. 18
Figure B.8 – Example 8. 18
Figure B.9 – Example 9. 19
Figure B.10 – Example 10 . 19
Figure B.11 – Example 11 . 20
Figure B.12 – Example 12 . 20
Figure B.13 – Example 13 . 20
Figure B.14 – Example 14 . 21
Figure B.15 – Example 15 . 21
Figure B.16 – Example 16 . 22
Figure B.17 – Example 17 . 22
Figure B.18 – Example 18 . 22
Table 1 – Replacing engineering language with language understandable for
operators . 10
– 4 – IEC TR 63183:2019 © IEC 2019
INTERNATIONAL ELECTROTECHNICAL COMMISSION
____________
GUIDANCE ON ERROR AND WARNING MESSAGES
FOR SOFTWARE USED IN RADIOTHERAPY
FOREWORD
1) The International Electrotechnical Commission (IEC) is a worldwide organization for standardization comprising
all national electrotechnical committees (IEC National Committees). The object of IEC is to promote international
co-operation on all questions concerning standardization in the electrical and electronic fields. To this end and
in addition to other activities, IEC publishes International Standards, Technical Specifications, Technical Reports,
Publicly Available Specifications (PAS) and Guides (hereafter referred to as "IEC Publication(s)"). Their
preparation is entrusted to technical committees; any IEC National Committee interested in the subject dealt with
may participate in this preparatory work. International, governmental and non-governmental organizations liaising
with the IEC also participate in this preparation. IEC collaborates closely with the International Organization for
Standardization (ISO) in accordance with conditions determined by agreement between the two organizations.
2) The formal decisions or agreements of IEC on technical matters express, as nearly as possible, an international
consensus of opinion on the relevant subjects since each technical committee has representation from all
interested IEC National Committees.
3) IEC Publications have the form of recommendations for international use and are accepted by IEC National
Committees in that sense. While all reasonable efforts are made to ensure that the technical content of IEC
Publications is accurate, IEC cannot be held responsible for the way in which they are used or for any
misinterpretation by any end user.
4) In order to promote international uniformity, IEC National Committees undertake to apply IEC Publications
transparently to the maximum extent possible in their national and regional publications. Any divergence between
any IEC Publication and the corresponding national or regional publication shall be clearly indicated in the latter.
5) IEC itself does not provide any attestation of conformity. Independent certification bodies provide conformity
assessment services and, in some areas, access to IEC marks of conformity. IEC is not responsible for any
services carried out by independent certification bodies.
6) All users should ensure that they have the latest edition of this publication.
7) No liability shall attach to IEC or its directors, employees, servants or agents including individual experts and
members of its technical committees and IEC National Committees for any personal injury, property damage or
other damage of any nature whatsoever, whether direct or indirect, or for costs (including legal fees) and
expenses arising out of the publication, use of, or reliance upon, this IEC Publication or any other IEC Publications.
8) Attention is drawn to the Normative references cited in this publication. Use of the referenced publications is
indispensable for the correct application of this publication.
9) Attention is drawn to the possibility that some of the elements of this IEC Publication may be the subject of patent
rights. IEC shall not be held responsible for identifying any or all such patent rights.
The main task of IEC technical committees is to prepare International Standards. However, a
technical committee may propose the publication of a Technical Report when it has collected
data of a different kind from that which is normally published as an International Standard, for
example "state of the art".
IEC TR 63183, which is a Technical Report, has been prepared by subcommittee 62C:
Equipment for radiotherapy, nuclear medicine and radiation dosimetry, of IEC technical
committee 62: Electrical equipment in medical practice.
The text of this Technical Report is based on the following documents:
Draft TR Report on voting
62C/738/DTR 62C/741/RVDTR
Full information on the voting for the approval of this Technical Report can be found in the
report on voting indicated in the above table.
This document has been drafted in accordance with the ISO/IEC Directives, Part 2.
In this document, the following print types are used:
– requirements and definitions: roman type;
– test specifications: italic type;
informative material appearing outside of tables, such as notes, examples and references: in smaller type.
–
Normative text of tables is also in a smaller type;
– TERMS DEFINED IN CLAUSE 3 OF IEC 60601-1, IN THIS DOCUMENT OR AS NOTED: SMALL CAPITALS.
The committee has decided that the contents of this document will remain unchanged until the
stability date indicated on the IEC website under "http://webstore.iec.ch" in the data related to
the specific document. At this date, the
...