gen nrs001 code of practice for creating specifications

7/28/2019 GEN NRS001 Code of Practice for Creating Specifications

1/35

ICS 01.120 NRS 001:2004

Edition 2

ISBN 0-626-15771-4

CODE OF PRACTICE FOR THEDRAFTING AND PRESENTATIONOF SPECIFICATIONS

N R S


2/35

This rationalized user specification is issued bythe Technology Standardization Department (TSD), Eskom,

on behalf of theUser Group given in the foreword

and is not a standard as contemplated in the Standards Act, 1993 (Act No. 29 of 1993).

Table of changes

Change No. Date Text affected

Correspondence to be directed to Printed copies obtainable from

The NRS Projects Manager Standards South AfricaThe Technology Standardization Department (TSD) Private Bag X191Eskom Pretoria 0001PO Box 1091Johannesburg 2000

Telephone : (012) 428-7911Fax : (012) 344-1568E-mail : [email protected]

Website: http://www.nrs.eskom.co.za Website : http://www.stansa.co.za

COPYRIGHT RESERVED

Printed in the Republic of South Africa

by Standards South Africa1 Dr Lategan Road, Groenkloof, Pretoria


3/35

NRS 001:2004

Foreword

This code of practice (COP) was prepared by the Technology Standardization Department (TSD) onbehalf of the Electricity Suppliers Liaison Committee (ESLC).

At the time of the acceptance of this second edition of NRS 001, the TSD comprised the followingmembers:

K Singh (Chairperson)D Browse

A FredericksP A JohnsonJ MasangoN MavhunguL MosimeV Sewchand

Annexes A, B, C, D and E are for information only.

This edition cancels and replaces edition 1 (NRS 001:1998).


4/35

NRS 001:2004

Introduction

The need has been identified for a code of practice (COP) that will ensure that specifications for theElectricity Supply Industry (ESI) are prepared and presented in a standardized format that will be

easily understood by users of those specifications. This COP, which is aimed at satisfying this need,is not comprehensive. It is based on StanSA's recommended practice, ARP 013, which in turn isbased on ISO/IEC Directives Part 3, and should be read in conjunction with ARP 013.

The practices set out in this COP are intended to assist compilers of specifications in describing thefunctional and physical requirements to be met by a product, process or service. This COP can beused as a basis for drafting and presenting enquiry or tender documentation for procurementpurposes. Model technical schedules are included at the back of this COP before the Bibliography.These can be used by a purchaser to prepare his own schedules to list any additional specifictechnical information necessary when a specification is to be used for procurement purposes.

Details such as transportation and commercial data are not relevant to performance and should notbe included in a specification. (They should, however, be included in invitations to tender or in

enquiry documents.) Quality assurance requirements are part of the purchasers particular policiesand do not relate to the technical nature of the product.

This COP provides writers, typists and others involved with writing and publishing specifications witha uniform format

a) that is in line with international and national good practice,

b) that is flexible enough to cater for particular requirements, and

c) that has model technical schedules for use in purchasing enquiries.

The ESLC expresses the wish that, in the national interest, all electricity suppliers adopt the

recommendations of this COP insofar as their particular conditions will permit.

Keywords

drafting, writing, practices, presentation, standard format, specifications.


5/35

1 NRS 001:2004

ContentsPage

1 Scope ............................................................................................................................................ 3

2 Normative references .................................................................................................................... 3

3 Terms, definitions and abbreviations ............................................................................................ 3

4 Requirements ................................................................................................................................ 4

4.1 General .............................................................................................................................. 4

4.2 Layout of document ........................................................................................................... 6

4.3 Expansion of the content of elements ............................................................................... 6

4.4 Typographical requirements .............................................................................................. 10

4.5 Electronic imaging ............................................................................................................. 11

4.6 Using technical schedules ................................................................................................. 12

4.7 Consolidated editions ........................................................................................................ 12

4.8 Reconfirmed editions ......................................................................................................... 12

4.9 Table of changes ............................................................................................................... 12

4.10 NRS and PIESA specifications .................................. 13

Annex A (informative) Structure and example of the layout of a typical specification . ............ 14

Annex B (informative) Verbal forms for the expression of provisions ............................................ 22

Annex C (informative) Miscellaneous information ........................................................................... 26

Annex D (informative) Example of a guide to purchasers on preparing an enquiry ....................... 27

Annex E (informative) Example of a model form for schedules A and B ....................................... 29

Bibliography ..................................................................................................................................... 30


6/35

NRS 001:2004 2

This page intentionally left blank


7/35

3 NRS 001:2004

CODE OF PRACTICE FOR THE DRAFTING AND PRESENTATION

OF SPECIFICATIONS

1 Scope

This code of practice sets out a uniform format for specifications. This format is intended for use inthe Electricity Supply Industry. The requirements of this code of practice can be applied, as far asthey are appropriate, to the drafting of codes of practice, guides, user manuals and related technicaldocuments.

2 Normative references

The following documents contain provisions which, through reference in this text, constituteprovisions of this code of practice. At the time of publication, the references indicated were valid.Compilers of documents are encouraged to apply the most recent editions of the documents listedbelow. Information on currently valid national and international standards and specifications can beobtained from Standards South Africa.

ARP 013, Rules for the structure and drafting of standards.

ISO/IEC Guide 2, Standardization and related activities General vocabulary.

3 Terms, definitions and abbreviations

For the purposes of this code of practice, the terms, definitions and abbreviations given in ARP 013and the following apply.

3.1 Terms and definitions

consolidated editionedition of a specification in which all approved amendments and technical corrigenda have beenincorporated

NOTE The consolidation will be reflected in the advanced edition number that will reflect the year(s) ofpublication of the amendments and corrigenda and the publication date of the base document.

informative elements

elements that are included in a document for information or guidance only and that are notconsidered to be part of the requirements of the document

normative elementselements setting out the provisions to which it is necessary to conform in order to be able to claimcompliance with the specification [ARP 013:1998, definition 3.2]

standarddocument, established by consensus and approved by a recognized body, that provides, forcommon and repeated use, rules, guidelines or characteristics for activities or their results, aimed atthe achievement of the optimum degree of order in a given context [ISO/IEC Guide 2: definition 3.2]

NOTE Standards should be based on the consolidated results of science, technology and experience andshould be aimed at the promotion of optimum community benefits.


8/35

NRS 001:2004 4

3.2 Abbreviations

ARP: a recommended practice, as written and published by StanSA

COP: code of practice

ESI: electricity supply industry

ESLC: electricity suppliers liaison committee

4 Requirements

4.1 General

4.1.1 Objective

The objective of this document is to set out practices that will enable writers of specifications todefine clear and unambiguous functional or physical provisions (or both) to be fulfilled by a product,process or service in accordance, where practicable, with internationally recognized standards. Aspecification shall

a) be as complete as necessary within the limits specified by its scope,

b) be consistent, clear and accurate,

c) take full account of the state of the art of the particular technology of the subject,

d) provide a framework for future technological development,

e) be easily understood by persons who have not participated in its preparation, and

f) be based on needs and not on wants.

The recommended practices given in ARP 013 shall generally be applied, insofar as they apply tospecifications for the ESI.

4.1.2 Style

To facilitate understanding by all readers, the language and style used in a technical specificationshall be as simple and concise as possible.

The reference works given in 6.6.2 of ARP 013:1998 and the following are recommended:

Chambers Dictionary of Science and Technology, 1999.

4.1.3 Uniformity

The structure, style, terminology and numbering within each document and within a series ofassociated documents shall, as far as possible, be identical. The guidelines given in 4.2 of

ARP 013:1998 shall apply.

4.1.4 Consistency of specifications

In order to achieve consistency, the text of every specification shall be in accordance with therelevant provisions of existing specifications and standards (see 4.3 of ARP 013:1998).


9/35

5 NRS 001:2004

4.1.5 General arrangement of subject matter

As a general rule an individual specification shall be prepared for each subject to be standardized. Aspecification may be split into parts under the same number. It can be further subdivided into

sections that deal with stand-alone components.

4.1.6 Description and numbering of divisions and subdivisions

4.1.6.1 Clause

A clause is the basic component in the subdivision of the content of a specification. Clauses shall benumbered using arabic numerals beginning with 1 for the Scope clause. Each clause shall have atitle (see 5.2.2 of ARP 013:1998).

4.1.6.2 Subclause

A subclause is a numbered subdivision of a clause. A primary subclause, for example, 5.1 and 5.2,

may be subdivided into secondary subclauses, for example, 5.1.1 and 5.1.2. Subclauses shall benumbered with arabic numerals as shown in the above examples.

A subclause shall not be created unless there is at least one more subclause at the same level. Forexample, a piece of text in clause 10 shall not be numbered 10.1 unless there is a subclause 10.2(see 5.2.3 of ARP 013:1998).

4.1.6.3 Paragraph

A paragraph is an unnumbered subdivision of a clause or subclause.

A hanging paragraph is the description given to a sentence or paragraph of text that is inserted intoa numbered sequence in an element, immediately after a heading, but is not itself numbered.

Hanging paragraphs shall be avoided. The text shall be incorporated into a suitable existingsubclause or omitted if it does not pertain to the performance of the product.

An example of the wrong way is:

4 Requirements

Text (Unnumbered paragraph of text. This is a hanging paragraph.)

4.1 Xxx

It should be:

4 Requirements

4.1 General

Text

4.2 Xxxx

Text

(Original hanging paragraph of text plus paragraph of General text. A pictorial representation isgiven in 5.2.4 of ARP 013:1998).


10/35

NRS 001:2004 6

4.2 Layout of document

The layout of the document shall be as follows:

Foreword (unnumbered element)

Introduction (unnumbered element)

Keywords (unnumbered element)

Table of contents (unnumbered element)

1 Scope

2 Normative references

3 Terms, definitionsand abbreviations

4 Requirements

NOTE If there are no test methods, marking requirements, other elements (see 4.3.12) or annexes, thedocument may be concluded after this element.

5 Test methods

6 Marking, labelling and packaging

If required, some or all of the following elements may be used, being numbered consecutively from

7, as appropriate for a particular specification with the exception of the Guide to purchasers onpreparing an enquiry, which shall appear as annex A, and the Bibliography, which shall not be

numbered.

Recommended spare parts

Training

Documentation

Annexes

Bibliography

4.3 Expansion of the content of elements

4.3.1 Title of the specification

The full title shall appear, in identical wording, on the cover and before the Scope element.

4.3.2 Foreword

This element is not numbered. It shall not contain any requirements (see 6.1.5 in ARP 013:1998)Every specification shall contain a Foreword that gives information relating to the organizationresponsible for its production, for example:

a) the name of the working group or the committee that prepared the specification, followed by the

names of members of the working group or committee, in alphabetical order but headed by thename of the working group or committee chairman;


11/35

7 NRS 001:2004

b) information regarding the approval of the specification (see 6.1.5 of ARP 013:1998); and

c) details of any document(s) superseded or replaced by the specification.

4.3.3 Introduction

This element is not numbered. The introduction shall explain briefly why the specification isnecessary, the relation of the specification to SANS, PIESA or IEC standards of the same subjectand the value that is added to the industry through implementation of the specification. It shall notcontain any requirements (see 6.1.6. of ARP 013:1998).

4.3.4 Keywords

This element is not numbered. As the term infers, those words applicable to the subject should beincluded under this heading. The words shall be listed in all lower case and shall be separated by acomma. Keywords need not be in alphabetical order.

4.3.5 Table of contents

This element is not numbered. The table of contents shall be listed on "Page 1". The variouselements of the specification shall be listed on this page.

4.3.6 Scope

This element shall be numbered 1, and shall normally appear on page 3. For a full description ofwhat might be contained in the Scope, see 6.2.1 of ARP 013:1998.

4.3.7 Normative references

This element shall be numbered 2 and shall have an explanatory opening paragraph. Thepreferred wording is given in clause 2 of this COP. Normative references shall be arrangedalphanumerically and shall not be dated.

When there is a need to reference text in the requirements of the specification, it is then necessaryto write the reference specification and year in the requirements of the specification (e.g. "table 3.1of SANS 1234:2000"). This is necessary because it is possible that table 3.1 might not exist in thenext edition of the referenced specification.

Only documents that are freely available and that are mentioned in the text in a manner that makestheir use essential for the application of the specification, shall be listed. To retain consistency ofnumbering of the clauses, insert Not applicable if there are no normative references.

4.3.8 Terms, definitions and abbreviations

This element shall be numbered 3. To retain consistency of numbering of the clauses insert Notapplicable if there are no terms, definitions or abbreviations. Only terms, definitions andabbreviations that are used in the document shall be listed.

All entries in this element shall be entered in alphabetical order and shall not be numbered. For thegeneral format, see 6.3.1, 6.3.2 and annex C of ARP 013:1998.

4.3.9 Requirements

This element shall be numbered 4 and shall contain the following:

a) all characteristics relevant to the aspect(s) of the product(s), process(es), or service(s) coveredby the specification, either explicitly or by reference (see 6.3.3 of ARP 013:1998);


12/35

NRS 001:2004 8

b) the required limiting values of quantifiable characteristics; and

c) for each requirement, either a reference to the test method for determining or verifying thevalues of the characteristic, or the test method itself ( see 6.3.5 of ARP 013:1998).

All requirements for the marking or labelling of equipment where such marking or labelling isessential for the correct and safe application or operation of the equipment, equipment rating platesand cable marking requirements, shall be included. If a specification specifies requirements fordifferent sizes of equipment and different voltages, currents, etc., this clause shall be split intogeneric (common) requirements and specific (size, voltage or current) requirements. Wheretechnical schedules based on the specification are prepared to facilitate purchasing, all specificrequirements (size, voltage or current) shall be given in the schedules.

Text from NRS, national and international standards shall be referred to, when applicable, but notrepeated. Only supplementary and differing requirements shall be given in detail.

4.3.10 Test methods

This element shall be numbered 5 and shall specify all tests required, including inspections andprocedures (see 6.3.5 of ARP 013:1998). To retain consistency of numbering if elements numbered

beyond 5 are used, insert Not applicable if there are no test methods.

Where relevant, there shall be a corresponding test for each requirement given in clause 4 of thespecification.

4.3.11 Marking, labelling and packaging

4.3.11.1 This element shall be numbered 6. To retain consistency of numbering if elements

numbered beyond 6 are used, insert Not applicable if there are no requirements for marking,labelling or packaging.

4.3.11.2 All marking, labelling and packaging required for transportation or storage (or both) ordisposal, shall be specified in this clause.If there is a requirement for technical information labels on

equipment, transformers, pressure vessels, etc., this requirement shall be specified in element 4(see 4.3.9).

4.3.11.3 This clause may include labels for specific requirements for the product (for example,handling instructions, date of manufacture).

4.3.11.4 For some equipment, it might be necessary to specify that the equipment is accompaniedby warning notices, hazard warnings, or by instructions to the user or installer, and to specify thenature of the warning notices and instructions.

4.3.11.5 If any specific documentation relating to transportation (customs clearance requirementsetc.) or storage is required, this information shall be given in the form of a requirement in this clause.

4.3.12 Specific optional items

4.3.12.1 General

Where applicable, the items covered in 4.3.12.2 to 4.3.12.4 shall be included and the elements

numbered consecutively, starting from 7.

4.3.12.2 Recommended spare parts

Where applicable, any recommendations for spare parts that will be necessary for anticipatedmaintenance shall be included in this element; alternatively the requirement could be included inequipment-specific technical schedules.


13/35

9 NRS 001:2004

4.3.12.3 Training

Where applicable, any training required by the purchaser in the use of the equipment covered by a

specification shall be included in this element; alternatively the requirement could be included inequipment-specific technical schedules (see 4.6).

4.3.12.4 Documentation

Where applicable, any documentation required to operate or use the equipment that is to beprovided by the supplier, shall be specified in this element.

4.3.13 Annexes

4.3.13.1 General

Annexes shall contain supplementary information of either a normative or an informative nature. The

information may be presented as formulas, graphs, drawings, tables or text. Annexes shall havealpha identifiers starting with A and be presented in the order in which they appear in the text. Thetwo types of annexes are described in 4.3.13.2 and 4.3.13.3.

When clauses, paragraphs, tables or figures in an annex are numbered, the annex alpha identifiershall precede the number.

4.3.13.2 Normative annexes

Normative annexes contain information that forms an integral part of the specification, which is moreconveniently presented as an annex.

Where a specification includes reference drawings, the numbers and titles of these drawings shall

be listed in a normative annex and copies of the drawings may be included as part of that annex.

4.3.13.3 Informative annexes

Informative annexes contain information that might help the reader to understand and apply thespecification. An informative annex does not form part of the requirements of a specification.

4.3.13.4 Guide to purchasers on preparing an enquiry and model form for technical

schedules

A guide to purchasers on preparing an enquiry shall always appear in annex A of the specification.

An example of a model form for technical schedules shall always appear in annex B of the

specification.

Reference to these annexes shall be made in the Scope of the specification.

NOTE Examples of the guide to purchasers on preparing an enquiry and the model form are given inannexes D and E.

4.3.14 Bibliography

The number and title of related specifications are included in the Bibliography. Do not includenormative references. Only informative references and other relevant specifications shall beincluded in the Bibliography. A bibliography is not numbered.

Do not add the year and amendment details of specifications listed in the bibliography of thespecification.


14/35

NRS 001:2004 10

4.4 Typographical requirements

4.4.1 Page set-up

Recommendations that cover page headers, footers and margins are given in annex A.

4.4.2 Fonts and margins

Recommended types and sizes of font, indenting, margins and other typographical requirements aregiven in the examples in annex A. Typographical requirements are printed in italics, in parentheses,next to the appropriate heading or example of text.

4.4.3 Page header and page layout

4.4.3.1 The header of each page shall contain the specification number, the year of publication andthe page number, set out as shown in the example in annex A.

When specifications are to be printed on both sides of the page, the specification number and dateof publication shall be on the left-hand side in the case of even-numbered pages and on the right-hand side in the case of odd-numbered pages. The use of the recommended page layout inannex A will facilitate this process.

4.4.3.2 If the Contents, Foreword and Introduction cover only two pages then the specification shallstart on page 3 and there shall be no blank page. The inside cover (including the Table of changes)shall remain unchanged.

The "Foreword" page shall not be numbered. The next page "Introduction" and the "Keywords" shallalso not be numbered.

The page thereafter shall be the "Contents" page and shall be numbered page 1. The next pageshall be left intentionally blank (unless the content page runs over two pages and shall be markedpage 2).

The next page (i.e. page 3) shall contain the "Title" and "Scope". Unlike the StanSA practice, the"Foreword" and "Introduction" shall not be listed in the contents page.

4.4.3.3 The different page layouts shall be in accordance with those in annex A.

4.4.4 Annex page headings

The heading of an annex page, for example Annex A, shall be 13 point font, in bold, in the centreof the page, and this shall be on every page of that annex. The status of an annex (normative or

informative) shall be indicated under the heading of the annex on the first page. In multi-pageannexes the pages following the first page shall have (continued) under the heading. The last pageof a multi-page annex shall have (concluded) under the heading.

4.4.5 Representation of numbers and numerical values

4.4.5.1 The decimal sign shall be a comma, on the line.

4.4.5.2 If a value less than 1 is written in decimal form, the decimal sign shall be preceded by a zeroas follows, 0,15 %, 0,75 mm, etc.

4.4.5.3 Each group of three digits reading to the right or left of a decimal sign shall be separated bya space from preceding or following digits respectively. Four-digit numbers designating years shall

not be separated.


15/35

11 NRS 001:2004

4.4.6 Figures

Each figure shall be inserted immediately after it has been referred to in the text or, if the figure islarger than the space available on a page, on the next page. The figure number and title shall be

centralized immediately below the figure. If a figure (or consecutive figures) covers one or morepages, it might be preferable to put them in an annex. Figures shall be presented in accordance with6.6.4 of ARP 013:1998.

All text within the boundaries of a drawing shall be the same font size. The preferred font size rangefor this text is 9 pt to 10 pt.

If all dimensions are given in the same units, the units shall be stated in the top right-hand corner ofthe drawing. Dimensions with more than three digits shall be written with a space after the first digit,for example, 1 800.

If a specification contains a large number of figures, which might be drawings that were producedindependently of the specification, it might be preferable to put all the figures into one annex and

give a list of the figures in the annex.

4.4.7 Tables

Each table shall be inserted immediately after it has been referred to in the text or, if the table islarger than the space available on a page, on the next page. The table number and title shall becentralized immediately above the table. If a table covers one or more pages, it might be preferableto put it in an annex. The text in a table shall be 9 point. Tables shall be presented in accordancewith 6.6.5 of ARP 013:1998.

4.4.8 Equations

Equations shall be expressed in mathematically correct form and shall be presented in accordance

with 6.6.9 of ARP 013:1998. An example of the presentation of an equation is given in annex A.

4.4.9 Footnotes

The use of footnotes is not recommended.

4.4.10 Notes integrated in the text

Notes integrated in the text of a specification shall only be used to give additional informationintended to assist the understanding or use of a specification. They shall not contain requirements.Notes shall be presented in accordance with 6.5.1 of ARP 013:1998.

4.4.11 Notes to figures and tables

4.4.11.1 Notes to figures shall be treated independently from notes integrated in the text. They shallnot contain requirements. Notes to figures shall be presented in accordance with 6.6.4.8 of

ARP 013:1998.

4.4.11.2 Notes to tables shall be treated independently from notes integrated in the text. They shallnot contain requirements. Notes to tables shall be presented in accordance with 6.6.5.6 of

ARP 013:1998.

4.5 Electronic imaging

There is an increasing demand for specifications to be available electronically, for reading and

printing. The software and equipment used to prepare and print the final, approved hard (paper)copy shall be such that when a specification is accessed by anyone using their own equipment, theimage is a true image of the content of the original, approved, paper master copy.


16/35

NRS 001:2004 12

4.6 Using technical schedules

4.6.1 If a purchaser has requirements that are not specifically covered in a specification, technical

schedules that specify his particular requirements can be added to his enquiry document. Thisnecessity shall be recognized by a working group when a specification is compiled. With regard tovariables, the text of the specification shall refer to technical schedules. For example, the climaticconditions in which the equipment is to be operated will be specified in the purchasers particularrequirements schedule, or, the dimensions of the component offered shall be stated in thetenderers schedule of equipment offered. Where reference is made (in the requirements of thespecification) to the model form for technical schedules for the first time, reference shall also bemade to the guide to purchasers on preparing an enquiry (i.e. reference annexes A and B for thefirst time).

4.6.2 Technical schedules shall not be a repetition of the specification in table format. It isunnecessary and bad practice to repeat in the schedule items that are covered in the specification.The information in technical schedules shall only be that which is not covered in the specification;

specific operating conditions, equipment ratings or materials that are not covered in a genericspecification.

4.6.3 The schedules prepared by the purchaser shall include spaces in the schedule page headersfor the enquiry number or name and the name of the tenderer and places for signature and date atthe bottom of the page.

4.7 Consolidated editions

All approved amendments to a specification shall be published by incorporation of the amendmentsin a new, consolidated editionof the specification. This shall be stated at the top right-hand side ofthe front cover under the specification number. The specification edition number shall show theconsolidation and adopt the year of publication of the latest amendment, for example,

Edition 1.1(2002). First edition 2000 incorporating amendment No. 1:2002 modified as appropriatefor the specification. Technical corrigenda shall be treated as amendments. The edition numbershall be advanced after the decimal point whenever an amendment is incorporated. A consolidatededition shall be allocated a new international standard book number (ISBN).

The Foreword of the specification shall be updated to explain the incorporation of an amendmentand to indicate the working group and the members of any group that approved the amendment, forexample, the ESLC. All information in the Foreword and the Introduction shall be checked forrelevance, and shall be updated if necessary. The table of changes shall be updated (see 4.9).

4.8 Reconfirmed editions

All specifications shall have a default review period of five years. If the working group agrees that nochanges are required and that use of the specification may continue in its current form, the currentedition of the specification shall be reconfirmed by the approval group, for example, the ESLC. Thisshall be indicated on the front cover. Alongside the edition number the word "Reconfirmed" followedby the year of reconfirmation shall be printed.

4.9 Table of changes

Provision shall be made for the amendment history of the specification to be recorded in a table. Thetable shall contain the amendment number, the date of the amendment and a brief description of theamendment or the text affected. An example of a table of changes can be seen on the inside coverof this code of practice.


17/35

13 NRS 001:2004

4.10 NRS and PIESA specifications

The existence of the PIESA specification will be mentioned in the foreword of the NRS with anindication of whether the NRS is equivalent (or not) to the PIESA at the time of approval of the NRS.

In the case of the NRS specification being equivalent to the PIESA specification, the following textshall be inserted in the foreword of the NRS specification:

"This NRS specification is equivalentto PIESA 10XX Edition n."

In the case of the NRS specification NOT being equivalent to the PIESA specification, the followingtext shall be inserted in the foreword of the NRS specification:

"This NRS specification is not equivalent to PIESA 10XX Edition n, but provides similar technicalrequirements for application in the SA ESI".


18/35

NRS 001:2004 14

Annex A(informative)

Structure and example of the layout of a typical specification

A.1 Format of headings and text

The formats for headings and text used are as follows:

Heading 1 (13 point, bold)(Paragraph spacing before and after, 10 point)



Heading 4 (10 point)(Paragraph spacing before and after, 10 point)

Text (10 point)(Paragraph spacing before and after, 6 point)


19/35

15 NRS 001:2004

Annex A(continued)

A.2 Example of a Contents page

1 12 pt, bold NRS 000:190010 pt10 pt10 pt

Contents (Heading 1 font as in A.1)

Page(10 point)

1 Scope .....................................................................................................................................

2 Normative references .............................................................................................................

3 Terms, definitions and abbreviations .....................................................................................

4 Requirements .........................................................................................................................

4.1 Heading ..........................................................................................................................

4.2 Heading ..........................................................................................................................

4.2.1 Heading (optional) .................................................................................................

4.2.2 Heading (optional) .................................................................................................

5 Tests ......................................................................................................................................

6 Marking, labelling and packaging ...........................................................................................

Annex A (normative/informative) Heading ...............................................................................

Annex B (normative/informative) Heading ...............................................................................

Bibliography ............................................................................................................................

For the contents list as given above, the size of the font is 10 point and clause numbers are bold, asindicated.


20/35

NRS 001:2004 16

Annex A(continued)

A.3 Example of the presentation of a Foreword and an Introduction

Foreword (Heading 1 font as in A.1)Text (Text font as in A.1)

Introduction (Heading 1 font as in A.1)Text (Text font as in A.1)


21/35

17 NRS 001:2004

Annex A(continued)

A.4 Example of the layout of the title page

TITLE OF SPECIFICATION (capital letters, 13 point, bold)

Part 2: (lower case, 13 point, bold)

Part title(lower case, 13 point, not bold)

1 Scope(Heading 1 font as in A.1)

Text (Text font as in A.1)

2 Normative references (Heading 1 font as in A.1)

The following standard wording:

In the case of PIESAs, the following note:

"NOTE Some of the international/regional standards that have been referenced might have been adoptedby national standards bodies as national standards. The reader is therefore advised to enquire about theavailability of such adoptions, as they will normally be more readily obtainable than the equivalentinternational/regional standards."


22/35

NRS 001:2004 18

Annex A(continued)

A.5 Example of the layout of terms, definitions and abbreviations

3 Terms, definitions and abbreviations(Heading 1 font as in A.1)

For the purposes of this specification, the following terms, definitions and abbreviations apply.

3.1 Terms and definitions (Heading 2 font as in A.1)

Word to be defined (unnumbered and alphabetical)

Explanatory text. No article e.g. A, An, The etc. (Heading 3 font as in A.1)

Example:

acceptableacceptable to the administering authority

3.2 Abbreviations (Heading 2 font as in A.1)Abbreviation (unnumbered and alphabetical): explanatory text. (Heading 3 font as in A.1 andtext font as in A.1)Example:

ESI: electricity supply industry

4 Requirements(Heading 1 font as in A.1)4.1 Heading(Heading 2 font as in A.1)

4.1.1 Heading(Heading 3 font as in A.1)

4.1.1.1 Text ( 4 font as in A.1)

4.1.1.2 Text

4.1.2 Heading(Heading 3 font as in A.1)


23/35

19 NRS 001:2004

Annex A(continued)

A.6 Example of a figure

200

Ground level

13

57

24

6

Positions of up to 7 lintelson narrow face of pole,alternating from top tobottom of the pole, andfrom front to rear

Narrow face

Wide face

Concrete pole

Bracket for two lintels

Bolt through topblank hole

1

800

Conductor tension

Dimensions in millimetres

Figure 1 Title(10 point bold)


24/35

NRS 001:2004 20

Annex A(continued

A.7 Example of the layout of an equation

a11

2a2 234,5234,5)( tt

R

Rtt += (10 point)

where

t2 is the temperature of windings when hot, expressed in degrees celcius;

ta is the temperature of cooling medium, expressed in degrees celcius;

R2 is the resistance of windings when hot, expressed in ohms;

R1 is the resistance of windings when cold, expressed in ohms;

T1 is the temperature of windings when cold, expressed in degrees celcius.

The equation shall be set out in the format above. All variables shall be in italics and they shall berepeated in the explanation and any qualifier, whether in subscript or superscript, shall be in normalfont. For example, nominal voltage: Vnom.x

A.8 Example of a table

Table 1 Heading(see Drawing title A.5)

NOTE The paragraph spacing for the text within the table is: top 0,08 cm, bottom 0,04 cm, left 0,11 cm, right0,11 cm.

1 2 3 4

Heading unit Heading Heading

Heading Heading Heading

1,2

2,0

2,2

11,0

3,2

44,0

NOTE The table should be in 9 pt.


25/35

21 NRS 001:2004

Annex A(continued)

A.9 Example of list of data sheets/drawings

When many drawings and data sheets are to be attached to a specification, they shall be listed inalphanumerical order. This example provides a model format for such a list. This information can benormative or informative.

Annex B(informative)

The following data sheets (drawings) form part of this annex:

Number TitleDSB 035 Mechanical plate heat exchanger(example)

etc.


26/35

NRS 001:2004 22


Verbal forms for the expression of provisions

B.1 General

The following information is taken from ARP 013.

NOTE Only singular forms are shown.

B.2 Verbal forms that indicate requirements

The verbal forms shown in table B.1 shall be used to indicate requirements strictly to be followed inorder to conform to the standard and from which no deviation is permitted. Insert table columnnumbers in all tables.

Table B.1 Requirement

1 2

Verbal form Equivalent expression for use in exceptional cases

shall is tois required toit is required thathas toonly is permittedit is necessary

shall not is not allowed (permitted) (acceptable) (permissible)is required to be notis required that be not

is not to be

Do not use must as an alternative for shall. (This will avoid any confusionbetween the requirements of a standard and external statutory obligations.)

Do not use may not instead of shall not to express a prohibition.

To express a direct instruction, for example referring to steps to be taken in a testmethod, use the imperative mood.

Example : Switch on the recorder.

B.3 Verbal forms that indicate recommendations

The verbal forms shown in table B.2 shall be used to indicate that among several possibilities one is

recommended as particularly suitable, without mentioning or excluding others, or that a certaincourse of action is preferred but not necessarily required, or that (in the negative form) a certainpossibility or course of action is deprecated but not prohibited.

Table B.2 Recommendation

1 2

Verbal form Equivalent expression for use in exceptional cases

should it is recommended thatought to

should not it is not recommended thatought not to


27/35

23 NRS 001:2004

Annex B(continued)

B.4 Verbal forms that indicate permission

The verbal forms shown in table B.3 are used to indicate a course of action permissible within thelimits of the standard.

Table B.3 Permission

1 2

Verbal form Equivalent expressions for use in exceptional cases

may is permittedis allowedis permissible

need not it is not required that

no is required

Do not use possible or impossible in this context.

Do not use can instead of may in this context.

NOTE May signifies permission expressed by the standard, whereas can refers to theability of a user of the standard or to a possibility open to him.

B.5 Verbal forms that indicate possibility and capability

The verbal forms shown in table B.4 are used for statements of possibility and capability, whethermaterial, physical or causal.

Table B.4 Possibility and capability

1 2

Verbal form Equivalent expressions for use in exceptional cases

can be able tothere is a possibility ofit is possible to

cannot be unable tothere is no possibility ofit is not possible to

NOTE See note to table 3.

B.6 The usage and application (in technical documents) of shall,should, may and will

B.6.1 Specifications

The principle that shall is reserved to signify a mandatory requirement in specifications

has been well established.

The rationale is as follows:

A specification is the means of communicating a customers requirements for a product or service tobe supplied by another party. To enable the customers to be assured that they receive the product

or service in accordance with the specification, all mandatory requirements are written with Shall.For example, "The cable shall be 10 m long".


28/35

NRS 001:2004 24

Annex B(continued)

The customer and supplier enter into a contract for the product or service to be supplied in

accordance with the specification. By having all mandatory requirements shall requirements, thesupplier is clear as to what has to be supplied, and also now contractually bound, because of thecontract, which includes the mandatory requirements of the specification.

In the case of physical products, by virtue of all mandatory requirements being identified by the useof shall, test houses are able to determine if the product can be certified as complying with thespecification.

The form shall is to be used for optional requirements too. If the customer selects that option, itbecomes mandatory.

For example, "When the electricity dispenser is provided with manual disconnecting facilities, such

facilities shall comply with the requirements of SABS 152".

If the customer needs additional requirements, these can, by mutual agreement, become mandatoryfor that specific contract only.

This does not preclude having should statements for guidance of the user, but these are not withinthe scope of compliance with the specification, and could often be included in informative annexes.

B.6.2 Codes of practice (the term includes Guidelines)

A COP is also a specification, often self imposed. Furthermore a COP is frequently the subject ofenforced application through legislation (e.g. SANS 10142-1), through Regulations of the OHS Act(NRS 048), through directives of the NER, or through internal directives or policies of Eskom.

The practice has been to use the word should in such CoPs (and in the past in guidelines), tosignify that while the specific action is preferred, or highly recommended, there might be otheractions that might be valid. This creates the difficulty that no one is clear as to what extent any partyis complying with the CoP. Hence it is proposed that all NRS specifications, whether annotatedSpecification or Code of practice, adopt shall for all mandatory requirements.

B.6.3 May/might

In the case of a code of practice, in particular, but also sometimes in specifications, it is oftennecessary, in addition to stating the basic requirement, to specify what other practices are allowed.In this case, the use of may is permitted.

The following example is from SANS 10142-1:

"All conductors of nominal cross-sectional area less than 16mm2shall be of annealed copper. In the

following cases alternative material may be used":

a) earth continuity conductors;

b) bonding conductors; and

c) aerial conductors.

May is only to be used in this context of permission.

Might has the meaning of a possibility (The circuit breaker might sometimes trip during the test)

and is only to be used in that context.

NOTE "could" and "could not" are alternatives to "might" and "might not".


29/35

25 NRS 001:2004

Annex B(concluded)

B.6.4 Will

The use of will has already been established in the context The purchaser will... to advise thesupplier who is required to comply with the specification that in order for him to comply, thepurchaser has to supply certain information, or perform certain actions. Very often, this relates toinformation to be provided by the purchaser in schedule A.

For example,

The following will be specified in schedule A:

a) type of standard SDB required (see 4.2.1),

b) the number of SDBs required, and

c) whether a combined or a separate neutral-earth SDB is required.

Will is only to be used in the context of intent by the purchaser.


30/35

NRS 001:2004 26

Annex C(informative)

Miscellaneous information

C.1 Dimensions shall be in millimetres not centimetres.

C.2 Sentences shall end with a full stop.

C.3 There shall be one space after the full stop between sentences in a paragraph.

C.4 When items are listed, the items may be identified, in accordance with ARP 013, using lowercase alpha characters in a single bracket; subdivisions of items shall have arabic numerals, in asingle bracket. An example of the use of list identifiers is given below.

The following equipment shall be used:

a) circuit-breakers;

1) oil-filled circuit-breakers, and

2) gas-filled (SF6) circuit-breakers ;

b) anchor rods; and

c) thimbles.

Alternatively "bullets" or the en dash may be used. (Use "Ctrl+Numerical minus" to access the en

dash, or "Insert, Symbol, and select en dash under Special characters".)

C.5 Units (voltage, pascal, kelvin, etc.) shall be written in full in text. When writing a numericalvalue of units the symbol for the unit shall be used. For examples, 230 V, 800 Pa, 85 K.

C.6 The use of trade names shall be avoided. Refer to 6.6.3 of ARP 013.

C.7 It is not necessary to use the term "subclause" when referring to elements of text (e.g. "see 5.1.2.1").

C.8 When describing a range of numbers avoid using the hyphen or em rule which all have theirown specific uses. Use the word "to". For examples, pages 19 to 25, 22 kV to 66 kV. The PC doesnot differentiate between the hyphen, em rule and numerical minus symbols.

C.9Avoid using foreign language abbreviations. Instead of "e.g." use "for example" in a sentence.The use of "e.g." in a table is acceptable. The use of "i.e." is acceptable.

C.10 When referring a user to an annex for further information about a subject, for example, (seeannex A) do not repeat the referral again for the same subject.


31/35

27 NRS 001:2004

Annex D(informative)

Example of a guide to purchasers on preparing an enquiry

Annex A(informative)

Guide to purchasers on preparing an enquiry

A.1 General

A model form is given in annex B to provide the purchaser with a convenient aid to purchasing. Theuse of this form is intended to obviate the need for preparing a detailed technical specification.

The purchaser need only specify compliance with this specification, provide the tenderers withdetails of any particular requirements, and set out the information he requires the tenderers toprovide, as indicated below.

A.2 Schedules

A.2.1 General

The model form for purchasing schedules provides the purchaser with examples of a schedule Aand a schedule B. In his enquiry, the purchaser should provide his own schedule A and schedule B,based on these examples.

A.2.2 Schedule A

Schedule A lists the requirements to be specified by the purchaser in enquiries and orders. Theserequirements include references to the relevant subclauses in this specification, to assist incompiling the schedules.

Where the text of any referenced standard stipulates that the purchaser shall indicate hisrequirements, these requirements should also be specified in schedule A. The purchaser should setout his particular requirements and choices in his own schedule A.

A.2.3 Schedule B

The purchaser should draw up his own schedule B (based on the schedule B in the model form inannex B) and request the tenderer to fill in this schedule. By doing this, the tenderer will be statingcompliance with this specification and will be providing the information the purchaser has requested.

NOTE 1 Where this specification allows the purchaser to make a choice, the example of schedule A (in themodel form in annex B) lists the preferred items/values/quantities. In the interests of standardization,purchasers are encouraged not to deviate from these preferences.

NOTE 2 When preparing his own schedule A and schedule B from the examples in the model form inannex B, the purchaser need include only the items he considers to be relevant or necessary.

NOTE 3 These schedules, when completed, become normative annexes to the enquiry specification.


32/35

NRS 001:2004 28

Annex D(concluded)

A.3 Commercial conditions

A purchaser will furthermore need to indicate the commercial conditions applicable and to draw up aprice schedule. Requirements for delivery, storage, packaging and marking should be included inthis part of the enquiry.

A.4 Quality assurance

This specification does not cover the purchasers possible requirements in respect of qualityassurance, quality control, inspections, etc., since each purchaser needs to consider the criticality ofthe application of each component and his own policy towards these matters. Purchasers arereferred to ISO 9001 for guidance.

A.5 Testing

Attention should be paid to the subject of testing and the related costs. Tests should be carried outby an accredited laboratory and tenderers should be requested to provide assurances in this regard.Price schedules should be so drawn up and covering letters so worded that the costs of all services,such as tests, delivery and spares, are declared and allowed for in the tender.

Before type tests, routine tests and sample tests are carried out, the number of samples used andthe frequency of sampling should be agreed upon with the supplier.

A.6 Revision of standards used as normative references

This specification, as has been indicated, is based on a set of defined standards, which might havebeen revised or amended. Most purchasers would, in principle, wish to employ the latest standards.The recommended approach is to secure an undertaking from a supplier to review the latestversions and amendments and to incorporate these where possible and agreeable to both parties. Ablanket commitment to work to the latest versions of standards creates legal difficulties ofinterpretation and risks for both parties, and should be properly assessed. This invariably cannot bedone in the time available.


33/35

29 NRS 001:2004

Annex E(informative)

Example of a model form for schedules A and B


Model form for schedules A and B

The model form is provided as a convenient aid to purchasing. Guidance on preparing an enquiryusing this form is given in annex A.

Schedule A: Purchaser's specific requirements

Schedule B: Guarantees and particulars of equipment to be supplied (to be completed by

tenderer)

Item Subclause Description Schedule A Schedule B


34/35

NRS 001:2004 30

Bibliography

1 Standardized terminology

IEC 60050 (all parts), International electrotechnical vocabulary.

NOTE This bibliography lists ISO standard terminology in individual technical fields.

International vocabulary of basic and general terms in metrology(BIPM/IEC/ISO/OIML).

2 Quantities, units and their symbols

IEC 60027 (all parts), Letter symbols to be used in electrical technology.

ISO 31(part 0 to part 13), Quantities and units.

ISO 1000, SI units and recommendations for the use of their multiples and of certain other units.

3 Technical drawings

IEC 60750, Item designation in electrotechnology.

ISO 128, Technical drawings General principles of presentation.

ISO 129, Technical drawings Dimensioning General principles, definitions, methods of executionand special indications.

ISO 406, Technical drawings Tolerancing of linear and angular dimensions.

4 Abbreviations

ISO 639, Codes for the representation of names of languages.

ISO 1951, Lexicographical symbols and topographical conventions for use in terminography.

5 Graphical symbols

IEC 60416, General principles for the formulation of graphical symbols.

IEC 60417, Graphical symbols for use on equipment Index, survey and compilation of the singlesheets.

NOTE IEC 60417 is a loose-leaf publication; supplements, containing new and revised sheets, are issuedfrom time to time. It is also available in two parts: IEC 604171, Overview and application, and IEC 604172,Symbol origins.

ISO 3461-1, General principles for the creation of graphical symbols Part 1: Graphical symbols foruse on equipment.

ISO 7000, Graphical symbols for use on equipment Index and synopsis.

NRS 002, Graphical symbols for electrical diagrams and drawings (a selection of symbols fromIEC 60617 that are commonly used in the Electricity Supply Industry).


35/35

31 NRS 001:2004

Bibliography(concluded)

6 Quality management system

SAS 9001/ISO 9001, Qualify management systems Requirements.

SANS 9004/ISO 9004 (SABS ISO 9004), Quality management systems Guidelines for performanceimprovements.

7 Drafting of standards

ISO/IEC Directives Part 3: Rules for the structure and drafting of international standards.

NOTE 1 Standards produced by the following international standards committees can also be a source ofreference:

IEC/TC 56, Reliability and maintainability(see IEC catalogue).

IEC/TC 75, Classification of environmental conditions (see IEC catalogue IEC 60721, 3 parts).

ISO/TC 3, Limits and fits (see ISO catalogue 17.040.10)

ISO/TC 19, Preferred numbers (see ISO catalogue ISO 3: 1973).

ISO/TC 69,Applications of statistical methods (see ISO catalogue 03.120.30).

NOTE 2 When specifications that address matters of safety are to be drafted, the following IEC Guide shouldbe referred to:

IEC Guide 60104, Guide to the drafting of safety standards, and the role of committees with safety pilot

functions and safety group functions.

NRS 002, Graphical symbols for electrical diagrams.

SANS 1-1, Standards for standards Part 1: The development of national standards and othernormative documents.

Standards South Africa

gen nrs001 code of practice for creating specifications

Documents