Guidelines for technical information for building and construction products A c c e s s e d
b y
R A I L
C O R P O R A T I O N
N E W
S O U T H
W A L E S
o n
2 3
D e c
2 0 1 0 AS/NZS 1388:1994 This Joint Australian/New Zealand Standard was prepared by Joint Technical Committee BD/52, Trade and Technical Literature for the Building Industry. It was approved on behalf of the Council of Standards Australia on 15 September 1994 and on behalf of the Council of Standards New Zealand on 19 September 1994. It was published on 5 December 1994. The following interests are represented on Committee BD/52: Australian Department of Administrative Services Australian Institute of Building Australian Institute of Construction Specifiers Building Research Association of New Zealand CSIRODivision of Building, Construction & Engineering, Australia Royal Australian Institute of Architects Review of Standards. To keep abreast of progress in industry, Joint Australian/ New Zealand Standards are subject to periodic review and are kept up to date by the issue of amendments or new editions as necessary. It is important therefore that Standards users ensure that they are in possession of the latest edition, and any amendments thereto. Full details of all Joint Standards and related publications will be found in the Standards Australia and Standards New Zealand Catalogue of Publications; this information is supplemented each month by the magazines The Australian Standard and Standards New Zealand, which subscribing members receive, and which give details of new publications, new editions and amendments, and of withdrawn Standards. Suggestions for improvements to Joint Standards, addressed to the head office of either Standards Australia or Standards New Zealand, are welcomed. Notification of any inaccuracy or ambiguity found in a Joint Australian/New Zealand Standard should be made without delay in order that the matter may be investigated and appropriate action taken. This Standard was issued in draft form for comment as DR 91229. A c c e s s e d
b y
R A I L
C O R P O R A T I O N
N E W
S O U T H
W A L E S
o n
2 3
D e c
2 0 1 0 AS/NZS 1388:1994 Australian/New Zealand Standard Guidelines for technical information for building and construction products First publi shed in Austr alia as AS 1388 1974. Jointl y revised and designated as Joint Standard AS/NZS 1388:1994. PUBLISHED JOINTLY BY: STANDARDS AUSTRALIA 1 The Crescent, Homebush NSW 2140 Austral ia STANDARDS NEW ZEALAND Level 10, Standards House, 155 The Terrace, Welli ngton 6001 New Zeal and ISBN 0 7262 9325 3 A c c e s s e d
b y
R A I L
C O R P O R A T I O N
N E W
S O U T H
W A L E S
o n
2 3
D e c
2 0 1 0 AS/NZS 1388:1994 2 PREFACE This Standard was prepared by the Joint Standards Australia/ Standards New Zealand Committee BD/52 on Trade and Technical Literature for the Building Industry to supersede AS 13881974, Recommendations for trade and technical literature for the building industry. The objective of this Standard is to provide producers of literature for the building and construction industries with guidelines for presenting technical information so that the information can be in a clear and structured form. The term informative has been used in this Standard to define the application of the appendix to which it applies. An informative appendix is only for information and guidance. Copyright STANDARDS AUSTRALIA/ STANDARDS NEW ZEALAND Users of Standards are reminded that copyright subsists in all Standards Australia and Standards New Zealand publications and software. Except where the Copyright Act allows and except where provided for below no publications or software produced by Standards Australia or Standards New Zealand may be reproduced, stored in a retrieval system in any form or transmitted by any means without prior permission in writing from Standards Australia or Standards New Zealand. Permission may be conditional on an appropriate royalty payment. Australian requests for permission and information on commercial software royalties should be directed to the head office of Standards Australia. New Zealand requests should be directed to Standards New Zealand. Up to 10 percent of the technical content pages of a Standard may be copied for use exclusively in-house by purchasers of the Standard without payment of a royalty or advice to Standards Australia or Standards New Zealand. Inclusion of copyright material in computer software programs is also permitted without royalty payment provided such programs are used exclusively in-house by the creators of the programs. Care should be taken to ensure that material used is from the current edition of the Standard and that it is updated whenever the Standard is amended or revised. The number and date of the Standard should therefore be clearly identified. The use of material in print form or in computer software programs to be used commercially, with or without payment, or in commercial contracts is subject to the payment of a royalty. This policy may be varied by Standards Australia or Standards New Zealand at any time. A c c e s s e d
2 0 1 0 5 AS/NZS 1388:1994 STANDARDS AUSTRALIA/ STANDARDS NEW ZEALAND Australian/New Zealand Standard Guidelines for technical information for building and construction products S E C T I O N 1 S C O P E A N D G E N E R A L 1.1 SCOPE This Standard sets out guidelines for content and presentation of technical information on products intended for use in the building and construction industries. This Standard does not cover commercial information. 1.2 REFERENCED DOCUMENTS AS 1000 The International System of Units (SI) and its application 1100 Technical drawing (all parts) 1101 Graphical symbols for general engineering (all parts) 1155 Metric units for use in the construction industry 1612 Paper sizes 1998 A6 microfiche for engineering and other data (excluding computer output microfiche) P5 Punching patterns for round holes used in files and loose leaf binders. NZMP 4212 Glossary of building terminology NZS/AS 1100 Technical drawing (all parts) 1101 Graphical symbols for engineering 1101.3 Part 3: Welding and non-destructive examination NZS 6501 Units of measurement SAA HB23 Thesaurus of Australian construction terms HB25 Australian building and construction definitions HB50 Glossary of building terms 1.3 DEFINITIONS For the purpose of this Standard, the definitions below apply. 1.3.1 Bindera hard cover with spine for loose-leaf pamphlets, e.g. A4 ring binder. 1.3.2 Booka document which has covers and a spine. 1.3.3 Booklet a document which has covers but no spine. 1. 3. 4 Document a self -contained publication, suff iciently complete to be compre- hended on its own. COPYRIGHT A c c e s s e d
b y
R A I L
C O R P O R A T I O N
N E W
S O U T H
W A L E S
o n
2 3
D e c
2 0 1 0 AS/NZS 1388:1994 6 1.3.5 Microfiche a transparent, flat, rectangular sheet of photographic film bearing a number of micro-images arranged in horizontal and vertical rows. The microfiche title area normally displays bibliographic information about the copied document in a size large enough to be read by the naked eye. 1.3.6 Pamphlet a sheet or sheets without covers or spine. 1.3.7 Product any material or item of any complexity, from raw material to a complete system, which is offered for sale. The term includes services having no material content. 1.4 TYPES OF TECHNICAL INFORMATION Different types of technical information may be required to satisfy different user needs. Examples of technical information for product data are as follows: (a) Illustrative information sheets. (b) Product data sheets. (c) Product specifications. (d) Product selection guides. (e) Safety guides. (f) Technical reports. (g) Design notes. 1.5 PRODUCT CLASSIFICATION Products should be classified in accordance with the key words in SAA HB23. COPYRIGHT A c c e s s e d
b y
R A I L
C O R P O R A T I O N
N E W
S O U T H
W A L E S
o n
2 3
D e c
2 0 1 0 7 AS/NZS 1388:1994 S E C T I O N 2 C O N T E N T 2.1 GENERAL The content of a document providing information about a product should include the items referred to in this Section. 2.2 ORGANIZATIONAL INFORMATION The name of the issuing organization such as the manufacturer, supplier or trade association, should appear in a consistent position in the layout of all its documents. The full name of the issuing organization in its correct legal form or trading name should be shown. If an acronym or abbreviation is used, instead of the name of the organization, it should be fully explained. Front covers and headings may carry an abbreviated form of name, either in words, acronym or as a logotype, with or without a symbol, providing the name of the organization appears in full at least once on each document. Where the name of the organization is represented by an acronym, such may be explained at the bottom of the last page of each document, together with the proprietary information described below. If an abbreviated form of the name is used in the body of the text, it is helpful to spell it out in full on the first occasion that it occurs. The name or acronym of the issuing organization should be followed by an address (or addresses) from which further information may be obtained. In addition, telephone, telex, facsimile transmission (fax) and electronic mail numbers for each address should be listed. At the bottom of the last page of each document, proprietary information of the issuing organization should be shown to enable information users to contact the organization by mail or telecommunications. The proprietary information should include a statement of any copyright ownership attached to the document. 2.3 COUNTRY OF ORIGIN OF MANUFACTURE The country of manufacture should be shown or, if appropriate, the proportion of content from different countries. 2.4 PRODUCT TRADE NAMES The manufacturers brand name of the product (or product name) should always be stated in full, and be placed in the heading zone of the product data sheet. 2.5 DATE OF ISSUE The month and year of publication issue or effectiveness should always be included on each sheet. If the document or sheet supersedes a previous edition, this should also be stated. 2.6 REFERENCE IDENTIFIER A short reference identification, such as a document number (see Clause 4.6), should be shown. 2.7 PRODUCT DESCRIPTION USING KEYWORDS A generic term should be stated to establish the identity of the product. The terms or keywords used should be specific enough to exclude other items having the same trade name. 2.8 DETAILED PRODUCT DESCRIPTION (See Appendix A) If the product name on its own does not make the nature of the product clear, it should be followed by a concise description which may state product properties and purpose. 2.9 LEGISLATIVE INFORMATION This would include information relevant to legislation, such as occupational health and safety. COPYRIGHT A c c e s s e d
b y
R A I L
C O R P O R A T I O N
N E W
S O U T H
W A L E S
o n
2 3
D e c
2 0 1 0 AS/NZS 1388:1994 8 2.10 STATEMENT OF LIMITATIONS A clear statement of any limitations on product use, application or installation practice is desirable and should be shown in all appropriate sections or grouped under one heading. 2.11 AUTHORITY OF INFORMATION Any performance characteristics shown should be supported by quoting the source of data, results of authoritative tests or by reference to examples in use. Where results of product appraisals or test results are given, they should be expressed in the form required by the authority for the appraisal or test with reference to the test method or appropriate Standard, if applicable. 2.12 ACCREDITATION Where the organization has recognized accreditation in systems, such as quality assurance, or certification (to carry out appraisals or tests) these should be referenced. 2.13 BUILDING CODE COMPLIANCE Product information should include a statement on the sections of the building code where the product is suitable for use, and should state those sections which are specifically excluded where this is not readily apparent. NOTE: The Building Code of Australia and the New Zealand Building Code have requirements for evidence of suitability of building materials. 2.14 MAINTENANCE Expected maintenance requirements should be described. NOTE: Legislation may require this information to be included. 2.15 WARRANTIES, CONTRACTORS ACCREDITATION AND SERVICING Terms, conditions and descriptions of these items should be provided if applicable. 2.16 SUPPLIERS A list of suppliers and their contact information or a contact to obtain supplier information should be provided. 2.17 DELIVERY Information such as units of supply and lead times should be shown. COPYRIGHT A c c e s s e d
b y
R A I L
C O R P O R A T I O N
N E W
S O U T H
W A L E S
o n
2 3
D e c
2 0 1 0 9 AS/NZS 1388:1994 S E C T I O N 3 P R O D U C T I O N 3.1 PRINTED MATERIAL 3.1.1 Paper sizes All documents should preferably be produced in the international A4 paper size (210 mm 297 mm). If other paper sizes are used, they should comply with AS 1612. 3.1.2 Printing material Board and ink should be appropriate for the intended use, e.g. strong enough to stand up to heavy usage and sufficiently opaque to avoid show- through. 3.1.3 Binding The method of binding chosen should allow each document to open easily and to lie flat to facilitate reference use at a desk or drawing board. To facilitate photocopying, the document should open completely flat. A square-backed spine, which can be printed with identification details, is desirable for multiple documents covering a series or range of products. 3.1.4 Organization of documents Documents which are in pamphlet form and designed to fit into a loose-leaf binder system, should preferably suit a four-ring system in accordance with AS P5. 3.1.5 Spine or back-cover information The following information, which should be factually consistent with the information on the front cover, should be printed on the spine of books and binders, and on the back cover of booklets: (a) Organizational name, acronym, symbol or logotype. (b) Document title, such as product catalogue, price list, product information (see Clause 4.13). On book and binder spines, printing should commence from the top and be readable downwards when the document is standing up and upright, or be readable left to right when the document is lying face-up. On wide spines printing may be readable left to right when the document is standing up. On booklets, printing should be close to the right-hand edge of the back cover, commencing at the top and readable downwards. Spines should be free of printed information on the lowermost 35 mm when upright to allow clear space for user referencing information, e.g. library indexing systems. 3.1.6 Margins To allow for punching and binding, margins on documents should not be less than 20 mm wide. Where a pamphlet includes a fold-back sheet, a binding allowance of 20 mm less than full width should be made to permit documents perusal without removing the document from the binder. 3.2 MICROFICHE Microfiche should comply with AS 1998, with a preferred reduction ratio of 24 times. 3.3 ELECTRONIC MEDIA Consideration of electronic-based media (word processor created) specifications should be considered, as these provide users with greater flexibility of use and allow the supplier or manufacturer simpler updating. COPYRIGHT A c c e s s e d
b y
R A I L
C O R P O R A T I O N
N E W
S O U T H
W A L E S
o n
2 3
D e c
2 0 1 0 AS/NZS 1388:1994 10 S E C T I O N 4 P R E S E N T A T I O N A N D S T Y L E 4.1 GENERAL Guidelines for presentation and style are given in style manuals, such as those referenced in Appendix B. 4.2 PAGE HEADERS AND FOOTERS Every page should carry a page number, preceded where appropriate by a document number. The title of the document (abbreviated, if necessary) should appear on each page as well as the date of issue (see Clause 2.5). 4.3 SECTION IDENTIFICATION Where documents are presented in large books and binders, each section should be indicated by means such as coloured divider leaves, cards, section tabs, or edge markings on pages. Edge markings should be not less than 3 mm wide. 4.4 CONTENTS LIST Documents of more than 12 pages should have a detailed list or table of contents. This list should appear with the preliminaries and should set out sequentially, with page numbers, all subdivisions of the document, including any index if provided. Books and binders, which are divided into sections by divider leaves or cards, should, in addition, have a contents list for each section on the relevant divider. 4.5 INDEX All documents of more than 32 pages should have an alphabetical index or indexes (e.g by subject or brand names) and should include, where appropriate, a numerical list of coded products. 4.6 DOCUMENT NUMBER Each document should be given an easily understood reference number (e.g. Handbook 1, Price List PL/3), if it is to be one of a series or if a number is desirable for identification purposes. 4.7 ILLUSTRATIONS, TECHNICAL DRAWINGS, TABLES AND CHARTS All illustrations, technical drawings, tables and charts should form a single numbered sequence throughout each document and should carry descriptive titles. Instructions and notes referring to such drawings, tables and charts should be positioned in such a way that they are fully visible in relation to these drawings, tables and charts. Illustrations should be clear and explanatory. Technical drawings should be drawn to stated ratio scales and comply with AS 1100 or NZS/AS 1100. Symbols and other graphic conventions should comply with AS 1100, AS 1101, NZS/AS 1100, NZS/AS 1101.3 or other relevant Australian or New Zealand Standards. Very short tabular arrangements (not more than five lines) may be included in the text without numbering. Where possible, information should be tabulated for compactness and ease of reference. Symbols denoting properties or units of measurement should be shown at the heads of columns and at the sides of rows, but not in the body of a table. 4.8 PHOTOGRAPHS Photographs should be used to supplement information given elsewhere, for aesthetic reasons, or to clarify installation and maintenance data. Where photographs are used, in order to aid reproduction, microfilming and electronic transfer, such as fax, they should be in dot form (halftone screen). COPYRIGHT A c c e s s e d
b y
R A I L
C O R P O R A T I O N
N E W
S O U T H
W A L E S
o n
2 3
D e c
2 0 1 0 11 AS/NZS 1388:1994 4.9 TYPOGRAPHY Typefaces for text should be clear and legible. The requirements of legibility, photocopying, facsimile (fax) transmission, microfiche production and optical character reading should be considered in the choice of typeface, inter-word spacing, line spacing and line length or column width. Where coloured inks are used, products should be selected which do not reduce legibility when photocopied or transmitted by fax. 4.10 UNITS OF MEASUREMENT AND PRESENTATION Metric (SI) units and international unit symbols should be used in technical data and comply with AS 1000 and AS 1155 or NZS 6501, except where legislation states otherwise. 4.11 TECHNICAL TERMS Technical terms should be those used in SAA HB25 and SAA HB50 or NZMP 4212. 4.12 ANNOTATIONS AND CODES Leader lines (as short as possible and differentiated from any construction or dimension lines) or numbers may be used to direct annotations to features. Manufacturers part numbers or codes shall always be given to identify items for ordering purposes and to enable computer encoding by product users. 4.13 DOCUMENT TITLE Titles of documents should appear on the front cover of books and booklets and in the heading zone of pamphlets. 4.14 LANGUAGE STYLE The language used in the document should be appropriate to the user or intended audience. COPYRIGHT A c c e s s e d
b y
R A I L
C O R P O R A T I O N
N E W
S O U T H
W A L E S
o n
2 3
D e c
2 0 1 0 AS/NZS 1388:1994 12 APPENDIX A DETAILED PRODUCT DESCRIPTION (Informative) This Appendix is a guide to the classification of relevant technical information for inclusion in technical literature for building and construction products. The headings in this Appendix are distinct categories of information valid for a wide range of products, (e.g. product identification). Categories of commercial information, such as price and availability, which change regularly, have not been included. The subheadings indicate the types of information expected to fall under each category heading. Specific product information varies among products with subheading lists indicative only and not intended to be complete for every product under consideration. Locating technical information within the literature will be assisted by the use of as many of the headings as are relevant. The headings and subheadings are not requirements. More suitable terms should be used if available. A classification of relevant technical information relating to building and construction products is listed as follows: PRODUCT IDENTIFICATION Product codes Product terminology Method to identify product and attributes precisely APPLICATIONS Recommended uses and applications Not recommended uses Warnings about uses and applications PHYSICAL Constituent materials Dimensions Mass and Volume PERFORMANCE Strength properties Thermal properties Durability FINISHED APPEARANCE Colour Texture Bond patterns INSTALLATION Substrate requirements Curing times Fixing and fastenings COPYRIGHT A c c e s s e d
b y
R A I L
C O R P O R A T I O N
N E W
S O U T H
W A L E S
o n
2 3
D e c
2 0 1 0 13 AS/NZS 1388:1994 SHIPPING AND STORAGE Packaging Protection during storage Shelf life MAINTENANCE AND OPERATION Cleaning methods Methods of operation or replacement Operation manual ENVIRONMENTAL IMPACT Energy usage CFC emissions Natural resource depletion DISPOSAL AND RECYCLING Recycling arrangements Removal instructions Controlling authorities APPRAISALS AND WARRANTIES Compliance with Standards Certified test results Warranty statements COPYRIGHT A c c e s s e d
b y
R A I L
C O R P O R A T I O N
N E W
S O U T H
W A L E S
o n
2 3
D e c
2 0 1 0 AS/NZS 1388:1994 14 APPENDIX B LIST OF RELATED DOCUMENTS (Informative) Attention is drawn to the following related documents which are intended for information and guidelines on presentation and style: Australian Government Publishing Service, Style Manual for authors, editors and printers GP Publications, The New Zealand Style Book for New Zealand writers, editors, journalists and students. The following is a document containing typical English expression and sentence structure as used in building specifications: NATSPEC, The National Building specification . COPYRIGHT A c c e s s e d
b y
R A I L
C O R P O R A T I O N
N E W
S O U T H
W A L E S
o n
2 3
D e c
2 0 1 0 This page has been left intentionally blank. A c c e s s e d