Structuring of technical information and documentation

Provides rules for the structuring of technical information and documentation, based on the use of a main document (leading document) for the keeping together of information for each object.

Structuration des informations et de la documentation techniques

Fournit des règles pour la structuration des informations et de la documentation technique, règles basées sur l utilisation d un document principal rassemblant les informations relatives à chaque objet.

General Information

Status
Published
Publication Date
17-Apr-2000
Current Stage
DELPUB - Deleted Publication
Completion Date
19-Oct-2011
Ref Project

Relations

Buy Standard

Standard
IEC 62023:2000 - Structuring of technical information and documentation Released:4/18/2000 Isbn:2831851971
English and French language
37 pages
sale 15% off
Preview
sale 15% off
Preview

Standards Content (Sample)


NORME CEI
INTERNATIONALE IEC
INTERNATIONAL
Première édition
STANDARD
First edition
2000-04
Structuration des informations
et de la documentation techniques
Structuring of technical information
and documentation
Numéro de référence
Reference number
CEI/IEC 62023:2000
Numéros des publications Numbering
Depuis le 1er janvier 1997, les publications de la CEI As from 1 January 1997 all IEC publications are
sont numérotées à partir de 60000. issued with a designation in the 60000 series.
Publications consolidées Consolidated publications
Les versions consolidées de certaines publications de Consolidated versions of some IEC publications
la CEI incorporant les amendements sont disponibles. including amendments are available. For example,
Par exemple, les numéros d’édition 1.0, 1.1 et 1.2 edition numbers 1.0, 1.1 and 1.2 refer, respectively, to
indiquent respectivement la publication de base, la the base publication, the base publication incor-
publication de base incorporant l’amendement 1, et la porating amendment 1 and the base publication
publication de base incorporant les amendements 1 incorporating amendments 1 and 2.
et 2.
Validité de la présente publication Validity of this publication
Le contenu technique des publications de la CEI est The technical content of IEC publications is kept
constamment revu par la CEI afin qu'il reflète l'état under constant review by the IEC, thus ensuring that
actuel de la technique. the content reflects current technology.
Des renseignements relatifs à la date de reconfir- Information relating to the date of the reconfirmation
mation de la publication sont disponibles dans le of the publication is available in the IEC catalogue.
Catalogue de la CEI.
Les renseignements relatifs à des questions à l’étude et Information on the subjects under consideration and
des travaux en cours entrepris par le comité technique work in progress undertaken by the technical
qui a établi cette publication, ainsi que la liste des committee which has prepared this publication, as well
publications établies, se trouvent dans les documents ci- as the list of publications issued, is to be found at the
dessous: following IEC sources:
• «Site web» de la CEI* • IEC web site*
• Catalogue des publications de la CEI • Catalogue of IEC publications
Publié annuellement et mis à jour Published yearly with regular updates
régulièrement (On-line catalogue)*
(Catalogue en ligne)*
• Bulletin de la CEI
• IEC Bulletin
Disponible à la fois au «site web» de la CEI*
Available both at the IEC web site* and
et comme périodique imprimé
as a printed periodical
Terminologie, symboles graphiques
Terminology, graphical and letter
et littéraux
symbols
En ce qui concerne la terminologie générale, le lecteur
For general terminology, readers are referred to
se reportera à la CEI 60050: Vocabulaire Electro-
IEC 60050: International Electrotechnical Vocabulary
technique International (VEI).
(IEV).
Pour les symboles graphiques, les symboles littéraux
For graphical symbols, and letter symbols and signs
et les signes d'usage général approuvés par la CEI, le
approved by the IEC for general use, readers are
lecteur consultera la CEI 60027: Symboles littéraux à
referred to publications IEC 60027: Letter symbols to
utiliser en électrotechnique, la CEI 60417: Symboles
be used in electrical technology, IEC 60417: Graphical
graphiques utilisables sur le matériel. Index, relevé et
symbols for use on equipment. Index, survey and
compilation des feuilles individuelles, et la CEI 60617:
compilation of the single sheets and IEC 60617:
Symboles graphiques pour schémas.
Graphical symbols for diagrams.
* Voir adresse «site web» sur la page de titre.
* See web site address on title page.

NORME CEI
INTERNATIONALE IEC
INTERNATIONAL
Première édition
STANDARD
First edition
2000-04
Structuration des informations
et de la documentation techniques
Structuring of technical information
and documentation
 IEC 2000 Droits de reproduction réservés  Copyright - all rights reserved
Aucune partie de cette publication ne peut être reproduite ni No part of this publication may be reproduced or utilized in
utilisée sous quelque forme que ce soit et par aucun procédé, any form or by any means, electronic or mechanical,
électronique ou mécanique, y compris la photocopie et les including photocopying and microfilm, without permission in
microfilms, sans l'accord écrit de l'éditeur. writing from the publisher.
International Electrotechnical Commission 3, rue de Varembé Geneva, Switzerland
Telefax: +41 22 919 0300 e-mail: inmail@iec.ch IEC web site http://www.iec.ch
CODE PRIX
Commission Electrotechnique Internationale
R
PRICE CODE
International Electrotechnical Commission
Pour prix, voir catalogue en vigueur
For price, see current catalogue

– 2 – 62023 © CEI:2000
SOMMAIRE
Pages
AVANT-PROPOS . 4
INTRODUCTION .6
Articles
1 Domaine d’application . 8
2 Références normatives. 8
3 Définitions. 8
3.1 Termes généraux relatifs à la structuration. 10
3.2 Termes généraux relatifs à la documentation. 12
3.3 Termes spécifiques. 12
4 Généralités .14
4.1 Principes de base de la structuration des systèmes, des installations
et des produits . 14
4.2 Objets et documents décrivant les objets. 18
4.3 Structure de la documentation et structure de document. 18
4.3.1 Structure de la documentation . 18
4.3.2 Structure de document . 18
5 Document principal et documents complémentaires. 20
5.1 Généralités . 20
5.2 Contenu du document principal . 22
5.2.1 Parties de document . 22
5.2.2 Partie identification. 22
5.2.3 Partie documents complémentaires . 22
5.2.4 Partie spécification. 24
5.3 Relation entre document principal et documents complémentaires. 24
5.3.1 Document principal. 24
5.3.2 Documents complémentaires. 24
5.4 Documents principaux à niveau unique ou multi-niveaux. 26
5.5 Application . 28
5.6 Classification du document principal. 28
Annexe A (informative) Exemple de document principal contenant une partie identification,
une partie documents complémentaires et des parties spécification . 32
Bibliographie . . 36
Figure 1 – Structuration générale des objets . 16
Figure 2 – Exemple de structure logique d'un document technique . 20
Figure 3 – Structure de la documentation pour un objet unique . 20
Figure 4 – Documents principaux et documents complémentaires; illustration des divers
degrés de répartition des informations dans différents documents. 26
Figure 5 – Structure de la documentation avec objets et documents . 30

62023  IEC:2000 – 3 –
CONTENTS
Page
FOREWORD . 5
INTRODUCTION .7
Clause
1 Scope . 9
2 Normative references . 9
3 Definitions. 9
3.1 General terms, related to structuring . 11
3.2 General terms, related to documentation . 13
3.3 Specific terms . 13
4 General. 15
4.1 Basic principles of structuring of systems, installations and products . 15
4.2 Objects and documents describing the objects . 19
4.3 Documentation structure and document structure . 19
4.3.1 Documentation structure. 19
4.3.2 Document structure . 19
5 Main document and complementary documents . 21
5.1 General. 21
5.2 Content of the main document. 23
5.2.1 Document parts. 23
5.2.2 Identification part. 23
5.2.3 Complementary documents part . 23
5.2.4 Specification part . 25
5.3 Relationship between main document and complementary documents
................... 25
5.3.1 Main document
.......................................................................................... 25
5.3.2 Complementary documents
....................................................................... 25
5.4 Single-level and multi-level main documents
.......................................................... 27
5.5 Application
............................................................................................................ 29
5.6 Classification of the main document
...................................................................... 29
Annex A (informative) Example of main document containing identification part,
complementary documents part and specification parts. 33
Bibliography . 37
Figure 1 – General structuring of objects. 17
Figure 2 – Example of logical structure of a technical document. 21
Figure 3 – Documentation structure for a single object . 21
Figure 4 – Main documents and complementary documents; illustration of different degrees
of partitioning of the information into different documents. 27
Figure 5 – Documentation structure with objects and documents. 31

– 4 – 62023 © CEI:2000
COMMISSION ÉLECTROTECHNIQUE INTERNATIONALE
____________
STRUCTURATION DES INFORMATIONS
ET DE LA DOCUMENTATION TECHNIQUES
AVANT-PROPOS
1) La CEI (Commission Électrotechnique Internationale) est une organisation mondiale de normalisation composée
de l'ensemble des comités électrotechniques nationaux (Comités nationaux de la CEI). La CEI a pour objet de
favoriser la coopération internationale pour toutes les questions de normalisation dans les domaines de
l'électricité et de l'électronique. A cet effet, la CEI, entre autres activités, publie des Normes internationales.
Leur élaboration est confiée à des comités d'études, aux travaux desquels tout Comité national intéressé par le
sujet traité peut participer. Les organisations internationales, gouvernementales et non gouvernementales, en
liaison avec la CEI, participent également aux travaux. La CEI collabore étroitement avec l'Organisation
Internationale de Normalisation (ISO), selon des conditions fixées par accord entre les deux organisations.
2) Les décisions ou accords officiels de la CEI concernant les questions techniques représentent, dans la mesure
du possible, un accord international sur les sujets étudiés, étant donné que les Comités nationaux intéressés
sont représentés dans chaque comité d’études.
3) Les documents produits se présentent sous la forme de recommandations internationales. Ils sont publiés
comme normes, spécifications techniques, rapports techniques ou guides et agréés comme tels par
...

Questions, Comments and Discussion

Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.