1、BSI BS*4940: PART*Z 94 m LbZ4bb9 0397572 T93 m BRITISH STANDARD *-*9” Technical information on construction products and services Part 2. Guide to content and arrangement BS 4940 : Part 2 : 1994 Jcinunry 1994 UDC 69:653.4 13:659.1S2.2 1 um BSI BSS4940: PARTS2 94 = Lb24bb9 0397573 92T Amd. No. BS 494
2、0 : Part 2 : 1994 Guide to content and arrangement Date Text affected Committees responsible for this British Standard The preparation of this British Standard was entrusted by Technical Committee B/500, Basic Data, to Subcommittee B/500/5, Building Technical Information, upon which the following bo
3、dies were represented: Association of Building Component Manufacturers British Standards Society Chartered Institute of Building Department of the Environment (Building Research Establishment) Institute of Building Control Library Association National Council of Building Material Producers Royal Ins
4、titute of British Architects Royal Institution of Chartered Surveyors This British Standard, having been prepared under the direction of Technical Committee Bi500, Basic Data, was published under the authority of the Standards Board and comes into effect on 15 January 1994 O BSI 1994 The following E
5、S1 references relate to the work on this standard: Committee reference B/500/5 Draft for comment 91/16249 DC ISBN O 680 22269 1 BSI BS*:YLiO: PART*2 94 Lti24bb 039757Li 8bb W EIS 4940 : Part 2 : 1994 Guide to content and arrangement Contents Guide Page Committees responsible Inside front cover Forew
6、ord 3 1 Scope 4 Annexes Tables 2 References 2.1 Normative references 2.2 Informative references 4 4 4 3 Content, structure and presentation 4 4 Choice of document 5 5 Content of document 5.1 General information 5.2 Technical information 5.3 5.4 Decimal markers 5.5 Quantities, units and symbols 5.6 C
7、ross-references 5.7 Footnotes and marginal notes 5.8 Abbreviations Sequence of information and headings 7 7 8 8 12 12 12 12 13 6 Structure of document 13 6.1 Volumes, parts and sections 13 6.2 Document identification 13 6.3 Headings 15 6.4 Numbering 15 7 Copyright 16 8 Editing, checking and proof re
8、ading 17 9 Foreign languages 17 A (informative) Use of approved quality and safety marks A. 1 General principles A.2 Types of mark A.3 Quality management systems A.4 Product conformity schemes A.5 Product approval schemes A.6 Test certific.ates A.7 Safety mark schemes A.8 National accreditation A.9
9、European conformity marking A. 1 O Logotypes B Checklist for headings 18 18 18 19 19 19 19 19 LO 20 20 21 - List of references 29 Index 31 1 Types of document (i 2 Headings for arrangernent of technical information 10 3 Information for front cover, back cover and spine 14 4 Example of heading hierar
10、chy 15 Contents 1 BSI BS*4940: PARTx2 94 W Lb24bb 0397575 7T2 W BS 4940 : Part 2 : 1994 Guide to content and arrangement Figures 1 Example of part of a contents page for volume 1 of a set of volumes Page 9 2 Example of part of an index with references to section and clause numbers, tables, diagrams
11、and appendices 11 3 Hierarchy of subdivisions 13 2 Contents BSI BS*4940: PART*2 94 1624667 0397576 639 m HS 4940 : Part 2 : 1994 Guide to content and arrangement Foreword This Part of BS 4940 has been prepared under the direction of the Technical Sector Board for Building and Civil Engineering. Toge
12、ther with BS 4940 : Part 1 : 1994 and Part 3 : 1994 it supersedes BS 4940 : 1973, which is withdrawn. BS 4940 has been revised to take account of changes, including the creation of the single European market, that have occurred since the first edition was published. Research sponsored by the Buildin
13、g Research Establishment and undertaken by the Building Centre Trust and York Institute for Advanced Architectural Studies showed that many manufacturers in the construction industry underrated the importance of providing good technical information in promoting their products. Comparatively few were
14、 aware that BS 4940 existed and some doubted whether it could help them. To encourage its wider use, this edition of BS 4940 is issued in a different form. It is published as a guide, divided into three Parts, each addressed to a different category of reader. The presentation and graphics are unlike
15、 those in other Eiritish Standards and are intended to illustrate the recommended principies. BS 4940 applies particularly to technical information about products and services. However, much of the guidance will be of use to those concerned with the presentation of other technical information for th
16、e construction industry. Good technical information is essential for the successful promotion of products and services and their proper application. Technical information should be kept separate and distinguished from purely advertising material. It can then b?e presented functionally and its value
17、will be increased (although some overlap between these two types of information is inevitable). BS 4940 is not in any ?way intended to inhibit an organization?s freedom to establish a corporate image for its publications. Use of the guide should ensure that tee hnical information in those publicatio
18、ns is of good quality, well structured and easy to retrieve, thus enhancing the value of the publications. Compliance with a British Standard does not of itself confer immunity from legal obligations. Foreword 3 BSI BSr4940: PART*2 94 1624669 0397577 575 BS 4940 : Part 2 : 1994 Guide to content and
19、arrangement 1 2 2.1 Normative references 2.2 Informative references 3 Scope This Part of BS 4940 gives guidance on the content of technical publications for products and services in the construction industry and on the way the content is arranged. It lists the types of document that may be needed, f
20、rom price list to handbook, and describes the content and structure of each type, with emphasis on the importance of providing full and accurate information. This Part of BS 4940 is intended for those concerned with deciding the content of technical information about products and services for the co
21、nstruction industry. Although it is written as a guide for preparing printed documents its recommendations apply generally to other forms of technical information. BS 4940 : Part 1 : 1994 is intended for those who have overall responsibility for an organizations publications policy; it deals with th
22、e preparation of the brief for technical publications and with the appointment of a Project Leader and Project Team to implement the brief. It also covers the commissioning of technical writers and designers. BS 4940 : Part 3 : 1994 is intended for those concerned with the presentation of technical
23、information. It therefore covers design considerations such as typography, graphics and page layouts as well as the details of artwork preparation and binding methods. References This Part of BS 4940 incorporates, by reference, provisions from specific editions of other publications. These normative
24、 references are cited at the appropriate points in the text and the publications are listed on page 29. Subsequent amendments to, or revisions of, any of these Publications apply to this Part of BS 4940 only when incorporated in it by amendment or revision. This Part of BS 4940 refers to other publi
25、cations that provide information or guidance. Editions of these publications current at the time of issue of this standard are listed on page 29, but reference should be made to the latest editions. Content, structure and presentation When the preferred form and type of information required has been
26、 agreed (see table 1 of BS 4940 : Part 1 : 1994) those responsible for its production should consider the three elements involved in the preparation of technical documents. Content: the total number of written and visual elements which make up the information contained in any one document (see claus
27、e 5). Structure: the way in which this information is arranged, its sequence and interrelation which makes the document easy to understand and to search (see clause 6). Presentation: the visual expression of the content and structure, by the use of typography and graphics, to produce an effective an
28、d attractive document (see BS 4940 : Part 3). 4 Scope BSI BI;*4940: PARTlr2 94 m Lb24bb 0393578 401 HS 4940 : Part 2 : 1994 Guide to content and arrangement 4 Choice of document It is essential to establish the target audience at the outset (for example information user groups such as architects, sp
29、ecifiers or contractors) and to understand the information user groups requirements, so that the relevant information can be prepared. Each document should be addressed to identified information user groups. The more precisely the purpose(s) of a document can be established, the easier it will be to
30、 write, arrange and present in a way that readers in the identified information user groups will find convenient and easy to follow. A variety of types of document (catalogues, price lists, etc.) are used for product information. The choice will depend mainly upon the range and type of information t
31、o be included. Table 1 sets out the features of a range of commonly used types of product document so that information providers can judge which type of document is most appropriate for a given purpose. This list does not describe all possible document types and arrangements but is intended to encou
32、rage the adoption of particular terms for the types of document listed. The type of document and its contents will affect the way it is stored and used. The following issues need to be considered. 0 A small document, such as a data sheet (or a page of a loose leaf catalogue), is more likely to be wi
33、thdrawn from a generally accessible office library into an individuals personal library or project files. 0 A document that covers several dissimilar products or services presents a problem in an office where the shelf order in the library reflects a classification system (see 5.1). Either the docum
34、ent could be filed according to its principal subject, in which case subsidiary subjects may be overlooked as they will not be in the correct shelf order, or the whole document could be removed from the classified shelves and filed separately, with the risk that its entire contents will be overlooke
35、d. Choice of document 5 BS 4940 : Part 2 : 1994 Guide to content and arrangement Generic type Purpose Scope, content and presentation Data sheet information 0 Condensed information with simple iliustrations linked to Technical and related for initial selection, specification and design 0 Single prod
36、uct or service (or restricted range); use in design and specification; 0 Concise presentation (usually no more than four A4) pages). Safety data law to ensure safety of the same conditions apply); sheet Information required by product in normal use 0 Application of single product or service (or rang
37、e to which 0 Information on chemical hazards and packaging; 0 Usually a single sheet, A4l) or A52). Design guide specifiers and designers services, or for specific applications; kchnical information for on the use of a product 0 Limited form of handbook for selected products or 0 Comprehensive infor
38、mation required by designers and specifiers, e.g. diagrams, calculation, typical specifications and examples of cost in use (but not prices); 0 A4l), may be loose leaf and may include data sheets. Catalogue Primary technical and 0 Distinct range of products or services (e.g. aii from one manufacture
39、r or all for one end use); 0 Essential information for selection, intended for a wide range of readers, extensively illustrated, may include a price list; sales document for a range of products or services 0 A4l), may be loose leaf and may include data sheets. Handbook In-depth technical Full range
40、of products or services; information to support the use of products or services (this is the most comprehensive document type) 0 Comprehensive coverage of technical data, demonstrates depth of technical support and design guidance. Includes detailed drawings examples of use and calculation and detai
41、ls of advisory services; 0 A4l) or A52), may be loose leaf, illustrations should preferably be to scale, bindings should be durable. Manual Information on the instailation and/or operation of a product Single product or service (or range of products usually installed as a single assembly). If a manu
42、al is prepared for a range of products separate information should be given for each product (or assembly of products); 0 Information linked to delivery, unpacking, storage, handling, installation, operation and maintenance needs with appropriate illustrations, e.g. stages of installation. May inclu
43、de information on ordering of replacement parts; A4l) or AEj2), may be loose leaf, may contain safety data sheets, bindings should be durable. Price list Prices and related 0 Same range of products and services as the catalogue; 0 Comprehensive purchasing information with cross-reference to the cata
44、logue, simple illustrations for identification only; 0 A4l), usually without colour, may be available to be bound into a catalogue and as a separate publication. ordering and cont,ractual information Other documents Documents providing technical information for specific purposes 0 Sing!e product or
45、range of products or services, specific applications, specific problems; 0 Information to supplement and expand on other documents described above, e.g. case studies, colour cards, span tables, test reports; o A4l), also A52) and other formats if display of information is improved or convenience for
46、 readers is increased. ) A4 should usually be used in a portrait (vertical) format. as docwrnents ir1 larids(:ape (horizontal) format do not fit conveniently into most storage arrangements. 2, A5 format fits more conveniently into a pocket than A4 but it should only be used for documents that will b
47、e extensively used on site. A robust binding that will lie flat when opened and coated paper will nsiially be needed with the A5 format. 6 Choice of document - ES1 BSa4940: PART*Z 94 Lb24bb9 0397580 ObT BS 4940 : Part 2 : 1994 Guide to content and arrangement 5 5.1 General information Fi liiig iiifo
48、rniation Content of document The content of ali technical documents may be considered in the following categories. 0 General infornmtwn. This includes commercial information, date of pub1icat;ion and revisions, filing information and the contents list. Technical info?mation (see 5.2). This includes
49、text, tables and figures. Give full details of the organization, including the address of its offices, manufacturing facilities and warehouses. Give details of any design or other advisory service. Include brief titles and logotypes if the organization is a member of a trade association or similar organization (see table 3). Give the month and year of publication (or the date from which the information is valid) on the front of all documents. Keep the original date reference on a documlent that is reprinted without change of any kind. Add the reprint date if there are mi
