ISO 9127:1988
(Main)Information processing systems — User documentation and cover information for consumer software packages
Information processing systems — User documentation and cover information for consumer software packages
Describes user documentation and cover information supplied with software packages. Is applicable to software packages sold off-the-shelf to consumers for business, scientific, educational and home use. References: ISO 6592; ISO 7185.
Systèmes de traitement de l'information — Documentation pour l'utilisateur et renseignements sur l'emballage des progiciels grand public
General Information
Relations
Buy Standard
Standards Content (Sample)
IS0
INTERNATIONAL STANDARD
9127
First edition
1988-09-01
INTERNATIONAL ORGANIZATION FOR STANDARDIZATION
ORGANISATION INTERNATIONALE DE NORMALISATION
MEXAYHAPOaHAfl OPTAHM3A~MR I-IO CTAHJJAPTM3A~MM
Information processing systems - User documentation
and cover information for consumer software packages
S ystt$mes de traitemen t de l7n forma tion - Documentation pour l’irtilisateur et
renseignemen ts sur l’emballage des progiciels grand public
Reference number
IS0 9127: 1988 (E)
---------------------- Page: 1 ----------------------
IS0 9127 :1988(E)
Foreword
IS0 (the International Organization for Standardization) is a worldwide federation of
national standards bodies (IS0 member bodies). The work of preparing International
Standards is normally carried out through IS0 technical committees. Each member
body interested in a subject for which a technical committee has been established has
the right to be represented on that committee. International organizations, govern-
mental and non-governmental, in liaison with ISO, also take part in the work. IS0
collaborates closely with the International Electrotechnical Commission (IEC) on all
matters of electrotechnical standardization.
Draft International Standards adopted by the technical committees are circulated to
the member bodies for approval before their acceptance as International Standards by
the IS0 Council. They are approved in accordance with IS0 procedures requiring at
least 75 % approval by the member bodies voting.
International Standard IS0 9127 was prepared by Technical Committee ISO/TC 97,
Information processing systems.
Users should note that all International Standards undergo revision from time to time
and that any reference made herein to any other International Standard implies its
latest edition, unless otherwise stated.
0 International Organization for Standardization, 1988
Printed in Switzerland
---------------------- Page: 2 ----------------------
IS0 9127 :1988 (E)
Contents
Page
.......................................................
0 Introduction.
.........................................
1 Scope and field of application
2 References .
3 Definitions. .
............................................
4 Categories of information
......................................
3
Section one : User documentation
3
5 Purpose .
............................................ 3
6 Reference documentation
.................................... 3
6.1 Identification of the package
.................................... 3
6.2 Components of the package
............................ 3
6.3 Functional description of the software
.........................................
4
6.4 Installing the software.
............................................ 4
6.5 Using the software
.................................. 5
6.6 Software technical information
...................................................... 5
6.7 Testing
........................................ 6
6.8 Contractual infdrmation
..................................................... 6
6.9 Glossary
6
6.10 Index .
.......................................... 6
6.11 End users’ comments
.............................................
6
7 Training documentation.
....................................... 6
8 Quick reference documentation
........................................ 7
Section two : Cover information
7
9 Purpose .
7
10 Content .
........................................ 7
10.1 Package identification.
................................ 7
10.2 Purpose and field of application.
7
Environment .
10.3
7
10.4 Input .
10.5 Output . 7
....................................
10.6 Restrictions on data or files 7
........................................... 7
10.7 Instructions for use
.................................... 7
10.8 Supplementary information
....................................... 7
10.9 Contractual information
..................................... 7
10.10 Customer service address.
............................................... 7
10.11 Items supplied
.......................................... 7
10.12 Standards and laws.
...................................... 7
10.13 Independent certification
7
Product code .
10.14
7
10.15 Price .
. . .
III
---------------------- Page: 3 ----------------------
This page intentionally left blank
---------------------- Page: 4 ----------------------
IS0 9127 : 1988 (E)
INTERNATIONAL STANDARD
Information processing systems - User documentation
and cover information for consumer software packages
tation which describes the content of the software as
0 Introduction
opposed to its use. Manufacturers produce this documen-
Consumer software packages are ready-made packages sold tation in order to be able to adequately support the soft-
ware, but in order to protect their proprietary interests, they
off-the-shelf to the consumer. Typically the software is sold
pre-wrapped with its user documentation. will not normally release it to the consumer.
The information provided in the user documentation on the
This International Standard does not give guidance on how the
cover of the package is often the only means whereby the
information should be presented, nor does the ordering given
manufacturer or marketing organization can communicate with
to information in this International Standard imply a prescribed
the consumer and user. It is therefore vitally important that suf-
order for the information content of the documentation of an
ficient information is given to enable the consumer to use the
individual package.
software successfully.
This International Standard is applicable to software packages
sold off-the-shelf to consumers for business, scientific, edu-
1 Scope and field of application
cational and home use.
This International Standard describes the user documentation
and cover information supplied with consumer software
2 References
packages :
IS0 6592, Information processing - Guidelines for the
- User documentation
documentation of computer-based application systems.
This documentation provides users with all the information
they need to install and run the software. Typically this
IS0 7185, Programming languages - PASCAL.
documentation takes the form of one or more manuals
included with the software inside the wrapping. As a result,
users are not able to consult the manual(s) until they have
bought the package.
3 Definitions
User documentation is described in section one of this Inter-
For the purpose of this International Standard the following
national Standard.
definitions apply :
- Cover information
3.2.1 consumer software package: A software product
‘This is information given on the external wrapping of the
designed and sold to carry out identified functions; the soft-
package. Its purpose is to enable prospective purchasers to
ware and its associated documentation are packaged for sale as
decide on the applicability of the software to their re-
a unit.
quirements.
Cover information is described in section two of this Inter-
3.2.2 consumer: The organization or person who buys the
national Standard.
software package.
This International Standard does not cover
-
Marketing literature. 3.2.3 end user : The person who uses the software package.
-
The brochures and leaflets whose purpose is to pro-
3.2.4 manufacturer: The organization which develops the
mote the package.
software package.
-
Technical descriptions of the software
All the system, program and data documentation required
3.2.5 marketing organization: The organization which
to maintain and enhance the software, i.e. the documen- markets the software package.
1
---------------------- Page: 5 ----------------------
IS0 9127 : 1988 (E)
which sells the software
3.2.6 supplier: The organization 4 Categories of information
package to the consumer.
Throughout this International Standard three categories of
information have been identified :
3.2.7 software support: The act of maintaining the soft-
a) Essential
i n a functional state.
ware nd its associated documentation
Information supplied with every package;
NOTE - Software support may be given by the manufacturer,
b) Conditional
marketing organization, supplier or other organization. In special
to which it is
contractually-agreed cases, consumers may be permitted to maintain Information supplied with every package
or enhance the software themselves.
relevant;
Optional
cl
3.2.8 environment: The configuration(s) of hardware and
Information supplied at the discretion of the ma nufac-
software in which the software operates.
turer or marketing organization.
For example, of computer, operating system, other Annotations (ESS), (CON) and (OPT) identify essential, con-
the type(s)
fo r which the software is designed. ditional and optional information respectively.
software and peripherals
---------------------- Page: 6 ----------------------
IS0 9127 : 1988 (E)
Section one I User documentation (ESS)
6.1.4 Dates (ESSI
5 Purpose
The purpose of user documentation is to provide the end user The release date of the original and current versions shall be
given.
with sufficient information for a clear understanding of
a) the purpose, functions and characteristics of the soft-
6.1.5 Manufacturer or marketing organization (ESS)
ware;
b) how to install and use the software; The name and address of the manufacturer or the organization
which markets the software package shall be given.
c) contractual rights and responsibilities.
NOTE - It is recommended that identification items 6.1 .l to 6.1.5 be
The documentation shall include reference documentation, for
displayed to the user whenever the software is loaded. Identification
day-to-day use with the software. Optionally it may include
information displayed on the screen must be consistent with the identi-
teaching documentation, designed to teach users how to use
fication information given in the reference documentation.
the software, It may also include cards, booklets or screen-
based information giving a summary of the operating instruc-
6.1.6 Key words (OPT)
tions and commands.
Where necessary, supplements to the documentation may be Key words or descriptors which characterize the package and
which could be used for indexing or retrieval purposes shall be
issued; for example :
given. For example; “word processing”, “spreadsheet”, “data-
- documentation errata; base management”, “simulation game”.
-
lists of identified but not covered errors in the software
product, with descriptions of known consequences.
6.1.7 Language (OPT)
Documentation may be supplied as hard copy or on an elec-
The language used for the software user interface and for the
tronic or other medium.
user documentation shall be identified (for example Japanese,
French, English).
6 Reference documentation (ESS)
6.2 Components of the package (ESS)
Reference documentation shall give a sufficiently clear and
comprehensive account to permit the end user to set up, install
6.2.1 Items supplied (ESS)
and use the software successfully.
All physical items supplied in the package (for example disks,
Where relevant, examples and illustrations shall be given and
cassettes, manuals, etc.) shall be listed and identified by name
any abbreviations and symbols used in the documentation shall
and quantity.
be defined.
Where relevant, the contents of the physical items (for example
Instructions shall also be included on how to use the reference
the programs supplied on the disks or cassettes, the docu-
documentation.
ments included in the manuals, etc.) shall be identified.
6.1 Identification of the package (ESS)
6.2.2 Associated items (CON)
6.1.1 Package name and code (ESS)
Any associated software, hardware or documentation which
The title or name which identifies the package and subtitle
may be relevant but which is not included with the package
which indicates its functions shall be given. The product code
shall be briefly described. The supplier details and order
or reference number of the package shall also be given.
number of any such item shall also be given.
6.1.2 Variant (CON)
. Functional description of the software
63
Additional identification for any package having two or more
current variants (for example for different equipment or
6.3.1 Purpose and field of application (ESS)
operating system) shall be given.
The purpose of the software and the functions it performs shall
be described. The extent of its functions shall be clarified, and,
6.1.3 Version (CON)
if necessary, any related functions that it does not perform shall
The version identification of the software, where applicable,
be identified. Where the software consists of more than one
together with an explanation of the version numbering system program, the purpose and function(s) of each component pro-
shall be given.
gram shall be described.
3
---------------------- Page: 7 ----------------------
IS0 9127 : 1988 EI
6.3.5 Security (CON)
Examples of the field of application of the software shall be
given.
Any security facilities provided to permit the user to protect the
software or its component programs and data from unauthor-
If necessary, the special and distinguishing features of the soft-
ized access shall be described.
ware, pl
...
ISO
NORME INTERNATIONALE
9127
Première édition
1988-09-01
INTERNATIONAL ORGANIZATION FOR STANDARDIZATION
ORGANISATION INTERNATIONALE DE NORMALISATION
MDK~YHAPO~HAR OPTAHM3A~Mfl Il0 CTAH,lJAPTM3A~MM
Systèmes de traitement de l’information -
Documentation pour l’utilisateur et renseignements
sur l’emballage des progiciels grand public
Information processing systems - User documentation and caver information for consumer
software packages
Numéro de référence
ISO 9127: 1988 (F)
---------------------- Page: 1 ----------------------
ISO 9127 : 1988 (FI
Avant-propos
L’ISO (Organisation internationale de normalisation) est une fédération mondiale
d’organismes nationaux de normalisation (comités membres de I’ISO). L’élaboration
des Normes internationales est en général confiée aux comités techniques de I’ISO.
Chaque comité membre int&essé par une étude a le droit de faire partie du comité
technique créé à cet effet. Les organisations internationales, gouvernementales et non
gouvernementales, en liaison avec I’ISO participent également aux travaux. L’ISO col-
labore étroitement avec la Commission électrotechnique internationale (CEI) en ce qui
concerne la normalisation électrotechnique.
Les projets de Normes internationales adoptés par les comités techniques sont soumis
aux comités membres pour approbation, avant leur acceptation comme Normes inter-
nationales par le Conseil de I’ISO. Les Normes internationales sont approuvées confor-
mément aux procédures de I’ISO qui requièrent l’approbation de 75 % au moins des
comités membres votants.
La Norme internationale ISO 9127 a été élaborée par le comité technique ISO/TC 97,
Systèmes de traitement de l’information.
L’attention des utilisateurs est attirée sur le fait que toutes les Normes internationales
sont de temps en temps soumises à révision et que toute référence faite à une autre
Norme internationale dans le présent document implique qu’il s’agit, sauf indication
contraire, de la dernière édition.
0 Organisation internationale de normalisation, 1988
Imprimé en Suisse
ii
---------------------- Page: 2 ----------------------
ISO 9127 : 1988 (FI
Sommaire
Page
........................................................
0 Introduction
Objet et domaine d’application .
1
2 Références .
3 Définitions .
4 Catégories de renseignements .
...................... 3
Section un : Documentation pour l’utilisateur (ESS)
.............................................................. 3
5 Objet
............................................. 3
6 Documents de référence
6.1 Identification du progiciel . 3
....................................... 3
6.2 Composants du progiciel
.............................. 3
6.3 Description fonctionnelle du logiciel
6.4 Installation du logiciel . 4
........................................... 4
6.5 Utilisation du logiciel
......................... 5
6.6 Renseignements techniques sur le logiciel
6
6.7 Miseàl’essai .
..................................... 6
6.8 Dispositions contractuelles
6
6.9 Glossaire .
6
6.10 Index .
................................. 6
6.11 Observations de l’utilisateur final
6
Documents de formation .
7
.................................. 6
8 Documentation à consultation rapide
7
....................
Section deux : Renseignements sur l’emballage (ESS)
9 Objet . 7
7
10 Contenu. .
...................................... 7
10.1 Identification du progiciel
7
10.2 Objet et champ d’application .
.............................................. 7
10.3 Environnement.
7
10.4 Entrée. .
7
Sortie .
10.5
................. 7
10.6 Restrictions relatives aux données ou aux fichiers
......................................... 7
10.7 Modalités d’utilisation
7
10.8 Renseignements supplémentaires. .
.................................... 7
10.9 Dispositions contractuelles
Adresse du service aux clients . 7
10.10
.............................................. 7
10.11 Articles fournis.
7
10.12 Normesetlois .
7
Certification indépendante. .
10.13
7
..............................................
10.14 Code de produit
7
Prix .
10.15
. . .
III
---------------------- Page: 3 ----------------------
Page blanche
---------------------- Page: 4 ----------------------
NORME INTERNATIONALE ISO 9127: 1988 (F)
Systèmes de traitement de l’information -
Documentation pour l’utilisateur et renseignements
sur l’emballage des progiciels grand public
0 Introduction l’enrichissement du progiciel, c’est-à-dire la documentation
qui décrit le contenu du logiciel plutôt que son mode
Les progiciels grand public sont des programmes standard ven-
d’emploi. Le concepteur prépare cette documentation afin
dus tout faits au consommateur. Ils sont habituellement vendus
d’assurer un soutien adéquat au logiciel. Toutefois, pour
préemballés et assortis de la documentation pour l’utilisateur.
protéger ses droits de propriété, il ne la divulgue habituelle-
ment pas au consommateur.
Les renseignements fournis dans la documentation pour I’utili-
sateur qui figure sur l’emballage du progiciel sont souvent le
La présente Norme internationale ne donne pas de directives
seul moyen dont dispose le concepteur ou l’organisation de
sur la façon de présenter les renseignements, et l’ordre suivi
commercialisation pour communiquer avec le consommateur
dans la présentation n’est pas une prescription implicite de la
utilisateur. II est donc d’une importance que ces renseigne-
méthode à suivre pour présenter le contenu de la documenta-
ments éclairent suffisamment ce dernier pour lui permettre de
tion d’un progiciel particulier.
bien utiliser le logiciel.
La présente Norme internationale s’applique aux progiciels
standard vendus au grand public à des fins commerciales,
1 Objet et domaine d’application
scientifiques, pédagogiques ou personnelles.
La présente Norme internationale décrit la documentation des-
tinée à l’utilisateur et les renseignements sur l’emballage fournis
2 Références
avec les progiciels grand public :
- Documentation destinée a l’utilisateur ISO 6592, Traitement de I?nformation - Principes généraux
relatifs à la documentation des systèmes d’application informa-
Cette documentation fournit à l’utilisateur tous les rensei-
tisés.
gnements dont il a besoin pour installer le logiciel et le faire
fonctionner. Elle est habituellement présentée dans un ou
ISO 7185, Langages de programmation - PASCAL.
plusieurs manuels emballés avec le logiciel. Les utilisateurs
ne peuvent donc pas consulter ces manuels à moins
d’acquérir ledit logiciel.
3 Définitions
La documentation pour l’utilisateur est décrite dans la sec-
tion un de cette Norme internationale.
Dans le cadre de la présente Norme internationale, les défini-
tions suivantes sont applicables.
- Renseignements sur l’emballage
II s’agit des renseignements présentés sur l’emballage exté-
3.2.1 progiciel grand public: Produit logiciel conçu pour
rieur du progiciel. Ils ont pour but de permettre à l’acheteur
exécuter les fonctions indiquées et vendu comme tel; le logiciel
éventuel de décider si le logiciel peut répondre à ses
et la documentation connexe sont emballés pour être vendus
besoins.
comme un tout.
Les renseignements sur l’emballage sont décrits dans la sec-
tion deux de cette Norme internationale.
3.2.2 consommateur: Organisation ou personne qui
acquiert le progiciel.
La présente Norme internationale n’aborde pas
- Les documents publicitaires
3.2.3 utilisateur final: Personne qui se sert du progiciel.
Les brochures et dépliants qui servent à faire la publicité du
3.2.4 concepteur: Organisation qui a mis au point le pro-
progiciel.
giciel.
- Les descriptions techniques du logiciel
Toute la documentation relative au système, au programme
3.2.5 organisation de commercialisation : Organisation
et aux données, nécessaire pour assurer la maintenance et
qui assure la mise en marché du progiciel.
1
---------------------- Page: 5 ----------------------
ISO 9127 : 1988 (FI
3.2.6 fournisseur: Organisation qui vend le progiciel au con- 4 Catégories de renseignements
sommateur.
La présente Norme internationale traite, son ensemble,
trois catégories de renseignements :
3.2.7 soutien du logiciel : Tâche de maintenir le logiciel et sa
a) Essentiels
documentation connexe dans un état fonctionnel.
Les renseignements fournis avec chaque progiciel;
NOTE - Le soutien du logiciel peut être assuré par le concepteur,
b) Pertinents
l’organisation de commercialisation, le fournisseur ou une autre organi-
sation. Dans des cas particuliers prévus par contrat, le consommateur
Les renseignements fourn is avec chaque progiciel
peut être autorisé à maintenir ou à enrichir lui-même le logiciel.
auquel ils s’appliquen
t;
c) Facultatifs
3.2.8 environnement: Configuration(s) de matériel et de
logiciel dans lesquelles le logiciel peut être exploité.
Les renseignements fournis à la discretion du concep-
teur ou de l’organisation de commercialisation.
Par exemple, le ou les types d’ordinateur, de systéme d’exploi-
tation, d’autre logiciel ou de périphériques pour lesquels le logi- Les annotations (ESS), (PERI et (FAC) désignent les renseigne-
ciel en cause a été conçu. ments essentiels, pertinents ou facultatifs, respectivement.
---------------------- Page: 6 ----------------------
ISO 9127 : 1988 (FI
Section un : Documentation pour htilisateur (ESS)
5 Objet 6.1.3 Version (PERI
Le numéro de version du logiciel, le cas échéant, ainsi qu’une
La documentation pour l’utilisateur a pour objet de fournir à
explication du système de numérotation des versions doivent
l’utilisateur final assez de renseignements pour lui permettre de
être donnés.
bien comprendre
6.1.4 Dates (ESS)
l’objet, les fonctions et les caractéristiques du logiciel;
a)
b) les modalités d’installation et d’utilisation du logiciel; Les dates de parution de la version originale et de la version
actuelle doivent être données.
les droits et les responsabilités de nature contractuelle.
cl
6.1.5 Concepteur ou organisation de commercialisation
La documentation doit comprendre des documents de réfé-
ESSI
rence pour faciliter l’utilisation au jour du logiciel. Elle peut
aussi inclure des documents de formation pour enseigner aux
Le nom et l’adresse du concepteur ou de l’organisation qui
utilisateurs comment se servir du logiciel. Enfin, elle peut aussi
commercialise le progiciel doivent être donnés.
comprendre des cartes, des brochures ou des images-écrans
qui récapitulent les instructions d’exploitation et les com-
NOTE - II est recommandé que les éléments d’identification 6.1 .l à
mandes. 6.1.5 paraissent à l’écran chaque fois que le logiciel est chargé. Les ren-
seignements affichés à l’écran doivent correspondre à ceux donnés
dans les documents de référence.
Au besoin, des suppléments à la documentation peuvent être
publiés, pa r exemple :
6.1.6 Mots-clés (FAC)
-
la liste des errata;
Les mots-clés ou les descripteurs qui caractérisent le progiciel
- la liste des fautes relevées dans le logiciel mais qui n’ont
et qui pourraient être utilisés à des fins d’indexation ou
pas été corrigées, assortie d’une description des consé-
d’extraction (par exemple N traitement de texte N, ((tableur N,
quences connues.
G gestion de base de données», ((jeu de simulation ~1 doivent
être donnés.
La documentation peut être fournie sur imprimé ou sur su
PP0r-t
électronique ou autre.
6.1.7 Langue (FAC)
La langue utilisée pour l’interface utilisateur et pour la docu-
6 Documents de référence (ESS) mentation destinée à l’utilisateur (par exemple le japonais, le
francais, l’anglais) doit être précisée.
,
Les documents de référence doivent donner un apercu assez
clair et détaillé du logiciel à l’utilisateur final pour lui permettre
6.2 Composants du progiciel (ESSI
de bien monter le logiciel, de l’installer et de l’utiliser comme il
faut.
6.2.1 Articles fournis (ESS)
Le cas échéant, des exemples et des illustrations doivent être
Tous les éléments matériels fournis avec le progiciel (par exem-
donnés et toutes les abréviations et tous les symboles employés
ple les disquettes, les cassettes, les manuels) doivent être énu-
dans la documentation doivent être définis.
mérés et précisés en indiquant le nom et la quantité.
Le cas échéant, le contenu des éléments matériels (par exemple
Des directives sur la façon de se servir des docu ments de réfé-
les programmes fournis sur disquettes ou cassettes, les docu-
rente doivent également être incluses.
ments incorporés dans les manuels) doit être précisé.
6.1 Identification du progiciel (ESS)
6.2.2 Articles connexes (PERI
6.1.1 Titre du progiciel et code de produit (ESSI
Tout élément connexe de logiciel, de matériel ou de documen-
tation qui peut être pertinent mais qui n’est pas fourni avec le
Le titre ou l’appellation qui identifie le progiciel et un sous-titre
progiciel doit être décrit brièvement. Des précisions sur le four-
qui en indique les fonctions doivent être donnés. Le code de
nisseur et le numéro de commande de tout article du genre doi-
produit ou le numéro de référence du progiciel doit également
vent être données.
être donné.
6.3 Description fonctionnelle du logiciel (ESS)
6.1.2 Variante (PER)
6.3.1 Objet et champ d’application (ESS)
D’autres précisions concernant tout progiciel qui comprend au
moins deux variantes sur le marché (par exemple pour des L’objet du logiciel et les fonctions qu’il exécute doivent être
appareils ou des systèmes d’exploitation différents) doivent décrits. L’étendue de ses fonctions et, au besoin, toute fonc-
être données. tion connexe qu’il n’exécute pas doit être précisée. Lorsque le
3
---------------------- Page: 7 ----------------------
60 9127 : 1988 (F)
logiciel comprend plus d’un programme, l’objet et les fonctions 6.3.5 Skurité (PERI
de chaque programme constitutif doivent être décrits.
Tout dispositif de sécurité qui permet à l’utilisateur de protéger
Des exemples du champ d’application du logiciel doivent être le logiciel ou ses programmes constitutifs et les données contre
donnés.
tout accès non autorisé doit être décrit.
Au besoin, les particularités du logiciel, les révisions prévues,
Les fonctions de vérification et de sauvegarde des données doi-
etc., doivent être décrites.
vent être décrites.
6.3.2 Environnement (ESS)
6.4 Installation du logiciel (ESS)
a) Exigences relatives au matériel (ESSI
6.4.1 Installation (ESS)
La ou les configurations de matériel requises pour
exploiter le logiciel, y compris la capacité de mémoire
Tout renseignement dont l’utilis
...
ISO
NORME INTERNATIONALE
9127
Première édition
1988-09-01
INTERNATIONAL ORGANIZATION FOR STANDARDIZATION
ORGANISATION INTERNATIONALE DE NORMALISATION
MDK~YHAPO~HAR OPTAHM3A~Mfl Il0 CTAH,lJAPTM3A~MM
Systèmes de traitement de l’information -
Documentation pour l’utilisateur et renseignements
sur l’emballage des progiciels grand public
Information processing systems - User documentation and caver information for consumer
software packages
Numéro de référence
ISO 9127: 1988 (F)
---------------------- Page: 1 ----------------------
ISO 9127 : 1988 (FI
Avant-propos
L’ISO (Organisation internationale de normalisation) est une fédération mondiale
d’organismes nationaux de normalisation (comités membres de I’ISO). L’élaboration
des Normes internationales est en général confiée aux comités techniques de I’ISO.
Chaque comité membre int&essé par une étude a le droit de faire partie du comité
technique créé à cet effet. Les organisations internationales, gouvernementales et non
gouvernementales, en liaison avec I’ISO participent également aux travaux. L’ISO col-
labore étroitement avec la Commission électrotechnique internationale (CEI) en ce qui
concerne la normalisation électrotechnique.
Les projets de Normes internationales adoptés par les comités techniques sont soumis
aux comités membres pour approbation, avant leur acceptation comme Normes inter-
nationales par le Conseil de I’ISO. Les Normes internationales sont approuvées confor-
mément aux procédures de I’ISO qui requièrent l’approbation de 75 % au moins des
comités membres votants.
La Norme internationale ISO 9127 a été élaborée par le comité technique ISO/TC 97,
Systèmes de traitement de l’information.
L’attention des utilisateurs est attirée sur le fait que toutes les Normes internationales
sont de temps en temps soumises à révision et que toute référence faite à une autre
Norme internationale dans le présent document implique qu’il s’agit, sauf indication
contraire, de la dernière édition.
0 Organisation internationale de normalisation, 1988
Imprimé en Suisse
ii
---------------------- Page: 2 ----------------------
ISO 9127 : 1988 (FI
Sommaire
Page
........................................................
0 Introduction
Objet et domaine d’application .
1
2 Références .
3 Définitions .
4 Catégories de renseignements .
...................... 3
Section un : Documentation pour l’utilisateur (ESS)
.............................................................. 3
5 Objet
............................................. 3
6 Documents de référence
6.1 Identification du progiciel . 3
....................................... 3
6.2 Composants du progiciel
.............................. 3
6.3 Description fonctionnelle du logiciel
6.4 Installation du logiciel . 4
........................................... 4
6.5 Utilisation du logiciel
......................... 5
6.6 Renseignements techniques sur le logiciel
6
6.7 Miseàl’essai .
..................................... 6
6.8 Dispositions contractuelles
6
6.9 Glossaire .
6
6.10 Index .
................................. 6
6.11 Observations de l’utilisateur final
6
Documents de formation .
7
.................................. 6
8 Documentation à consultation rapide
7
....................
Section deux : Renseignements sur l’emballage (ESS)
9 Objet . 7
7
10 Contenu. .
...................................... 7
10.1 Identification du progiciel
7
10.2 Objet et champ d’application .
.............................................. 7
10.3 Environnement.
7
10.4 Entrée. .
7
Sortie .
10.5
................. 7
10.6 Restrictions relatives aux données ou aux fichiers
......................................... 7
10.7 Modalités d’utilisation
7
10.8 Renseignements supplémentaires. .
.................................... 7
10.9 Dispositions contractuelles
Adresse du service aux clients . 7
10.10
.............................................. 7
10.11 Articles fournis.
7
10.12 Normesetlois .
7
Certification indépendante. .
10.13
7
..............................................
10.14 Code de produit
7
Prix .
10.15
. . .
III
---------------------- Page: 3 ----------------------
Page blanche
---------------------- Page: 4 ----------------------
NORME INTERNATIONALE ISO 9127: 1988 (F)
Systèmes de traitement de l’information -
Documentation pour l’utilisateur et renseignements
sur l’emballage des progiciels grand public
0 Introduction l’enrichissement du progiciel, c’est-à-dire la documentation
qui décrit le contenu du logiciel plutôt que son mode
Les progiciels grand public sont des programmes standard ven-
d’emploi. Le concepteur prépare cette documentation afin
dus tout faits au consommateur. Ils sont habituellement vendus
d’assurer un soutien adéquat au logiciel. Toutefois, pour
préemballés et assortis de la documentation pour l’utilisateur.
protéger ses droits de propriété, il ne la divulgue habituelle-
ment pas au consommateur.
Les renseignements fournis dans la documentation pour I’utili-
sateur qui figure sur l’emballage du progiciel sont souvent le
La présente Norme internationale ne donne pas de directives
seul moyen dont dispose le concepteur ou l’organisation de
sur la façon de présenter les renseignements, et l’ordre suivi
commercialisation pour communiquer avec le consommateur
dans la présentation n’est pas une prescription implicite de la
utilisateur. II est donc d’une importance que ces renseigne-
méthode à suivre pour présenter le contenu de la documenta-
ments éclairent suffisamment ce dernier pour lui permettre de
tion d’un progiciel particulier.
bien utiliser le logiciel.
La présente Norme internationale s’applique aux progiciels
standard vendus au grand public à des fins commerciales,
1 Objet et domaine d’application
scientifiques, pédagogiques ou personnelles.
La présente Norme internationale décrit la documentation des-
tinée à l’utilisateur et les renseignements sur l’emballage fournis
2 Références
avec les progiciels grand public :
- Documentation destinée a l’utilisateur ISO 6592, Traitement de I?nformation - Principes généraux
relatifs à la documentation des systèmes d’application informa-
Cette documentation fournit à l’utilisateur tous les rensei-
tisés.
gnements dont il a besoin pour installer le logiciel et le faire
fonctionner. Elle est habituellement présentée dans un ou
ISO 7185, Langages de programmation - PASCAL.
plusieurs manuels emballés avec le logiciel. Les utilisateurs
ne peuvent donc pas consulter ces manuels à moins
d’acquérir ledit logiciel.
3 Définitions
La documentation pour l’utilisateur est décrite dans la sec-
tion un de cette Norme internationale.
Dans le cadre de la présente Norme internationale, les défini-
tions suivantes sont applicables.
- Renseignements sur l’emballage
II s’agit des renseignements présentés sur l’emballage exté-
3.2.1 progiciel grand public: Produit logiciel conçu pour
rieur du progiciel. Ils ont pour but de permettre à l’acheteur
exécuter les fonctions indiquées et vendu comme tel; le logiciel
éventuel de décider si le logiciel peut répondre à ses
et la documentation connexe sont emballés pour être vendus
besoins.
comme un tout.
Les renseignements sur l’emballage sont décrits dans la sec-
tion deux de cette Norme internationale.
3.2.2 consommateur: Organisation ou personne qui
acquiert le progiciel.
La présente Norme internationale n’aborde pas
- Les documents publicitaires
3.2.3 utilisateur final: Personne qui se sert du progiciel.
Les brochures et dépliants qui servent à faire la publicité du
3.2.4 concepteur: Organisation qui a mis au point le pro-
progiciel.
giciel.
- Les descriptions techniques du logiciel
Toute la documentation relative au système, au programme
3.2.5 organisation de commercialisation : Organisation
et aux données, nécessaire pour assurer la maintenance et
qui assure la mise en marché du progiciel.
1
---------------------- Page: 5 ----------------------
ISO 9127 : 1988 (FI
3.2.6 fournisseur: Organisation qui vend le progiciel au con- 4 Catégories de renseignements
sommateur.
La présente Norme internationale traite, son ensemble,
trois catégories de renseignements :
3.2.7 soutien du logiciel : Tâche de maintenir le logiciel et sa
a) Essentiels
documentation connexe dans un état fonctionnel.
Les renseignements fournis avec chaque progiciel;
NOTE - Le soutien du logiciel peut être assuré par le concepteur,
b) Pertinents
l’organisation de commercialisation, le fournisseur ou une autre organi-
sation. Dans des cas particuliers prévus par contrat, le consommateur
Les renseignements fourn is avec chaque progiciel
peut être autorisé à maintenir ou à enrichir lui-même le logiciel.
auquel ils s’appliquen
t;
c) Facultatifs
3.2.8 environnement: Configuration(s) de matériel et de
logiciel dans lesquelles le logiciel peut être exploité.
Les renseignements fournis à la discretion du concep-
teur ou de l’organisation de commercialisation.
Par exemple, le ou les types d’ordinateur, de systéme d’exploi-
tation, d’autre logiciel ou de périphériques pour lesquels le logi- Les annotations (ESS), (PERI et (FAC) désignent les renseigne-
ciel en cause a été conçu. ments essentiels, pertinents ou facultatifs, respectivement.
---------------------- Page: 6 ----------------------
ISO 9127 : 1988 (FI
Section un : Documentation pour htilisateur (ESS)
5 Objet 6.1.3 Version (PERI
Le numéro de version du logiciel, le cas échéant, ainsi qu’une
La documentation pour l’utilisateur a pour objet de fournir à
explication du système de numérotation des versions doivent
l’utilisateur final assez de renseignements pour lui permettre de
être donnés.
bien comprendre
6.1.4 Dates (ESS)
l’objet, les fonctions et les caractéristiques du logiciel;
a)
b) les modalités d’installation et d’utilisation du logiciel; Les dates de parution de la version originale et de la version
actuelle doivent être données.
les droits et les responsabilités de nature contractuelle.
cl
6.1.5 Concepteur ou organisation de commercialisation
La documentation doit comprendre des documents de réfé-
ESSI
rence pour faciliter l’utilisation au jour du logiciel. Elle peut
aussi inclure des documents de formation pour enseigner aux
Le nom et l’adresse du concepteur ou de l’organisation qui
utilisateurs comment se servir du logiciel. Enfin, elle peut aussi
commercialise le progiciel doivent être donnés.
comprendre des cartes, des brochures ou des images-écrans
qui récapitulent les instructions d’exploitation et les com-
NOTE - II est recommandé que les éléments d’identification 6.1 .l à
mandes. 6.1.5 paraissent à l’écran chaque fois que le logiciel est chargé. Les ren-
seignements affichés à l’écran doivent correspondre à ceux donnés
dans les documents de référence.
Au besoin, des suppléments à la documentation peuvent être
publiés, pa r exemple :
6.1.6 Mots-clés (FAC)
-
la liste des errata;
Les mots-clés ou les descripteurs qui caractérisent le progiciel
- la liste des fautes relevées dans le logiciel mais qui n’ont
et qui pourraient être utilisés à des fins d’indexation ou
pas été corrigées, assortie d’une description des consé-
d’extraction (par exemple N traitement de texte N, ((tableur N,
quences connues.
G gestion de base de données», ((jeu de simulation ~1 doivent
être donnés.
La documentation peut être fournie sur imprimé ou sur su
PP0r-t
électronique ou autre.
6.1.7 Langue (FAC)
La langue utilisée pour l’interface utilisateur et pour la docu-
6 Documents de référence (ESS) mentation destinée à l’utilisateur (par exemple le japonais, le
francais, l’anglais) doit être précisée.
,
Les documents de référence doivent donner un apercu assez
clair et détaillé du logiciel à l’utilisateur final pour lui permettre
6.2 Composants du progiciel (ESSI
de bien monter le logiciel, de l’installer et de l’utiliser comme il
faut.
6.2.1 Articles fournis (ESS)
Le cas échéant, des exemples et des illustrations doivent être
Tous les éléments matériels fournis avec le progiciel (par exem-
donnés et toutes les abréviations et tous les symboles employés
ple les disquettes, les cassettes, les manuels) doivent être énu-
dans la documentation doivent être définis.
mérés et précisés en indiquant le nom et la quantité.
Le cas échéant, le contenu des éléments matériels (par exemple
Des directives sur la façon de se servir des docu ments de réfé-
les programmes fournis sur disquettes ou cassettes, les docu-
rente doivent également être incluses.
ments incorporés dans les manuels) doit être précisé.
6.1 Identification du progiciel (ESS)
6.2.2 Articles connexes (PERI
6.1.1 Titre du progiciel et code de produit (ESSI
Tout élément connexe de logiciel, de matériel ou de documen-
tation qui peut être pertinent mais qui n’est pas fourni avec le
Le titre ou l’appellation qui identifie le progiciel et un sous-titre
progiciel doit être décrit brièvement. Des précisions sur le four-
qui en indique les fonctions doivent être donnés. Le code de
nisseur et le numéro de commande de tout article du genre doi-
produit ou le numéro de référence du progiciel doit également
vent être données.
être donné.
6.3 Description fonctionnelle du logiciel (ESS)
6.1.2 Variante (PER)
6.3.1 Objet et champ d’application (ESS)
D’autres précisions concernant tout progiciel qui comprend au
moins deux variantes sur le marché (par exemple pour des L’objet du logiciel et les fonctions qu’il exécute doivent être
appareils ou des systèmes d’exploitation différents) doivent décrits. L’étendue de ses fonctions et, au besoin, toute fonc-
être données. tion connexe qu’il n’exécute pas doit être précisée. Lorsque le
3
---------------------- Page: 7 ----------------------
60 9127 : 1988 (F)
logiciel comprend plus d’un programme, l’objet et les fonctions 6.3.5 Skurité (PERI
de chaque programme constitutif doivent être décrits.
Tout dispositif de sécurité qui permet à l’utilisateur de protéger
Des exemples du champ d’application du logiciel doivent être le logiciel ou ses programmes constitutifs et les données contre
donnés.
tout accès non autorisé doit être décrit.
Au besoin, les particularités du logiciel, les révisions prévues,
Les fonctions de vérification et de sauvegarde des données doi-
etc., doivent être décrites.
vent être décrites.
6.3.2 Environnement (ESS)
6.4 Installation du logiciel (ESS)
a) Exigences relatives au matériel (ESSI
6.4.1 Installation (ESS)
La ou les configurations de matériel requises pour
exploiter le logiciel, y compris la capacité de mémoire
Tout renseignement dont l’utilis
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.