NISO Z39 18-2005 Scientific and Technical Reports Preparation Presentation and Preservation《科学与技术报告的编制 描述和保存》.pdf

1、 ANSI/NISO Z39.18-2005 ISBN: 1-880124-66-1 Scientific and Technical Reports Preparation, Presentation, and Preservation Abstract: This Standard outlines the elements, organization, and design of scientific and technical reports, including guidance for uniform presentation of front and back matter, t

2、ext, and visual and tabular matter in print and digital formats, as well as recommendations for multimedia reports. An American National Standard Developed by the National Information Standards Organization Approved: July 27, 2005 by the American National Standards Institute Published by the Nationa

3、l Information Standards Organization NISO Press, Bethesda, Maryland, U.S.A. About NISO Standards NISO standards are developed by the Standards Committees of the National Information Standards Organization. The development process is a strenuous one that includes a rigorous peer review of proposed st

4、andards open to each NISO Voting Member and any other interested party. Final approval of the standard involves verification by the American National Standards Institute that its requirements for due process, consensus, and other approval criteria have been met by NISO. Once verified and approved, N

5、ISO Standards also become American National Standards. These standards may be revised or withdrawn at any time. For current information on the status of this standard contact the NISO office or visit the NISO website at: http:/www.niso.org Published by: NISO Press 4733 Bethesda Avenue, Suite 300 Bet

6、hesda, MD 20814 www.niso.org Copyright 2005 by the National Information Standards Organization All rights reserved under International and Pan-American Copyright Conventions. No part of this book may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photoc

7、opy, recording, or any information storage or retrieval system, without prior permission in writing from the publisher. All inquiries should be addressed to NISO Press, 4733 Bethesda Avenue, Suite 300, Bethesda, MD 20814. ISSN: 1041-5653 ISBN: 1-880124-66-1 ANSI/NISO Z39.18-2005 2005 NISO Page iii C

8、ontents Page Foreword . vii 1 General Information 1 1.1 Rationale for Revision . 1 1.2 Role of Standard 2 1.3 Scope of Standard. 2 1.4 Audience of Standard 2 1.5 Best Practices 2 2 Referenced Publications 3 2.1 American National Standards 3 2.2 Other Standards 3 2.3 Other Publications . 3 3 Key Conc

9、epts Incorporated in This Standard 4 3.1 Metadata 4 3.2 Persistence 4 3.3 Interoperability . 4 3.4 Creation . 4 3.5 Discovery. 5 3.6 Presentation in Digital Format . 5 3.6.1 Document Type Definition (DTD) . 6 3.6.2 XML Document. 6 3.6.3 XSL (Style Sheet). 6 3.7 Presentation. 6 3.8 Dissemination 6 3.

10、9 Access and Distribution. 7 3.10 Maintenance and Preservation 7 4 Components of Reports Overview 8 4.1 Introduction 8 4.2 Metadata 8 4.2.1 Descriptive Metadata 8 4.2.2 Structural Metadata 8 4.2.3 Administrative Metadata. 8 4.3 Components 9 ANSI/NISO Z39.18-2005 Page iv 2005 NISO Contents (continued

11、) Page 5 Components of Reports Details 10 5.1 Front Matter10 5.1.1 Cover.11 5.1.2 Title Section 11 5.1.2.1 Report Number .17 5.1.2.2 Title and Subtitle.17 5.1.2.3 Author(s) / Creator(s)17 5.1.2.4 Performing and Sponsoring Organizations 18 5.1.3 Notice of Distribution/Access Restrictions 18 5.1.3.1 C

12、opyright 18 5.1.3.2 Distribution Limitations / Notices 18 5.1.4 Format Information22 5.1.5 Report Documentation Page.22 5.1.6 Abstract .22 5.1.7 Contents22 5.1.8 List(s) of Figures and Tables 23 5.1.9 Foreword .24 5.1.10 Preface24 5.1.11 Acknowledgments.24 5.2 Body Matter24 5.2.1 Summary.24 5.2.2 In

13、troduction .25 5.2.3 Methods, Assumptions, and Procedures 25 5.2.4 Results and Discussion.25 5.2.5 Conclusions.26 5.2.6 Recommendations 26 5.2.7 References26 5.3 Back Matter 27 5.3.1 Appendices .27 5.3.2 Bibliography 28 5.3.3 List(s) of Symbols, Abbreviations, and Acronyms 28 5.3.4 Glossary 29 5.3.5

14、 Index .29 5.3.6 Distribution List29 6 Presentation and Display 30 6.1 Subordination .30 6.1.1 General .30 6.1.2 Print-Specific Guidelines.30 6.1.3 Non-Print-Specific .30 6.2 Visual and Tabular Matter30 6.2.1 General .30 6.2.1.1 Print-Specific Guidelines 31 6.2.1.2 Non-Print-Specific.31 6.2.2 Figure

15、s 31 6.2.3 Tables .32 6.2.3.1 General.32 6.2.3.2 Print-Specific Guidelines 33 6.2.3.3 Non-Print-Specific.33 ANSI/NISO Z39.18-2005 2005 NISO Page v Contents (continued) Page 6.3 Presentation Format 33 6.3.1 General. 34 6.3.1.1 Line Length 34 6.3.1.2 Font Choice 34 6.3.2 Print-Specific 34 6.3.2.1 Imag

16、e Area. 34 6.3.2.2 Margins 34 6.3.2.3 Paper and Ink. 35 6.3.2.4 Printing Equipment. 35 6.4 Designation 35 6.4.1 General. 35 6.4.2 Print-Specific 35 6.5 Units and Numbers 36 6.6 Formulas and Equations36 6.7 Footnotes or Endnotes 38 6.8 References and Bibliographic Entries . 38 6.9 Symbols, Abbreviati

17、ons, and Acronyms 38 6.9.1 General. 38 6.9.2 Print-Specific 39 6.10 Glossary Entries 39 6.11 Index Entries 39 6.11.1 General. 39 6.11.2 Print-Specific 39 6.11.3 Non-Print-Specific. 39 6.12 Errata. 39 6.12.1 General. 39 6.12.2 Print-Specific 40 6.12.3 Non-Print-Specific. 40 Appendix A Selected Annota

18、ted Bibliography 41 A.1. General 41 A.2. Writing, Usage, Style, Grammar, and English-Language Dictionaries 41 A.3. Style Manuals and Guides. 43 A.4. Specialized Dictionaries, Encyclopedias, and Handbooks 44 A.5. Technical Writing Material . 46 A.6. Standards and Symbols 47 A.6.1. Standards . 47 A.6.

19、2. Graphic Symbols 47 A.6.3. Letter Symbols 49 A.7. Library Reference Material 49 A.8. Graphic Arts. 50 A.9. Typography and Publication Design 51 ANSI/NISO Z39.18-2005 Page vi 2005 NISO Contents (continued) Page Appendix B Glossary53 Appendix C Dublin Core Data Elements.57 Appendix D Formats for Org

20、anizing a Scientific or Technical Report 60 Appendix E Report Documentation Page, Standard Form (SF) 29862 Appendix F XML DTD and Sample XSL (Style Sheet) .64 Index.80 Figures Figure 1: Components used in digital format representation. 5 Figure 2a: Sample cover page for which the performing and spon

21、soring organizations are the same 13 Figure 2b: Sample title page for which the performing and sponsoring organizations are the same 14 Figure 3a: Sample cover for which the performing and sponsoring organizations are different . 15 Figure 3b: Sample title page for which the performing and sponsorin

22、g organizations are different.16 Figure 4: Sample page with a notice of restricted distribution . 20 Figure 5: Sample page with no distribution restrictions . 21 Figure 6: Sample table of contents section 23 Figure 7: Example of graphic devices used as color substitutes. 32 Figure 8: Nomenclature fo

23、r the parts of a table . 33 Figure 9: Sample multi-line equation with extra space before and after 37 Figure 10: Sample chemical equation spread over two lines 37 Tables Table 1: Components of reports 9 ANSI/NISO Z39.18-2005 2005 NISO Page vii Foreword (This Foreword is not a part of ANSI/NISO Z39.1

24、8-2005, Scientific and Technical Reports Preparation, Presentation and Preservation. It is included for information only.) This Standard provides guidelines about the preparation, presentation, and preservation of scientific and technical reports. Its purpose is to foster uniformity in these reports

25、 for ease of information retrieval while permitting diversity in presentation based on the rapidly changing environment driven by the growing digital environment. It also provides guidelines to aid in assuring permanent access to digital documents. The Standard does not provide guidance on other typ

26、ical technical information products, such as journal articles, proposals, technical specifications, or technical and consumer manuals. This publication is a standard rather than a report and, therefore, does not follow in every particular the report format described. Moreover, the language of the St

27、andard is couched in the indicative rather than the subjective mood (“is,“ not “shall“ or “must“), which is typically used in standards. Previously this Standard only addressed reports produced with paper and ink. While many reports are still produced in this manner, a growing number are “born digit

28、al“ and distributed electronically. Additionally, scientific and technical reports may be created combining text, data streams, audio, video, and other media to produce complex, multimedia documents that can only exist digitally. In developing this Standard, Committee AW recognized that the way a Te

29、chnical Report is organized has evolved over the past 30 years from a content-based organization pattern to a user-based one. This Standard presents alternatives that should be used based on report purpose and presentation. Committee AW recognizes that presentation is an important consideration. Rep

30、orts that are in digital format, unlike paper and ink reports, can be presented in several ways depending on individual preferences and capabilities. In the development of this Standard, Committee AW examined existing practices and conventions from a wide variety of organizations, institutions, and

31、associations as reflected in the annotated Bibliography (Appendix A). These sources were chosen because they represent a variety of report producers and are available to the report-producing public. Where practices vary, committee members resolved the differences based on their collective experience

32、s. Where appropriate, options are recommended to accommodate the widely varied needs of report producers. Because of this variety, not all the elements described are mandatory for a report, although the placement and sequence of report elements should be consistent. For example, federal agencies use

33、 a Report Documentation Page, but many academic and industrial report producers do not. The use and placement of Report Documentation Pages is considered optional by the Standard to accommodate local practices; therefore instructions for preparing them are given in Appendix E. The Standard provides

34、explicit guidance about bibliographic data elements that appear on covers and title pages (and, if used, Report Documentation Pages) of reports when they are printed or presented in image form. Compliance with these guidelines ensures thorough, consistent, and uniform bibliographic description and c

35、ontrol of data essential to libraries, abstracting services, and other technical information organizations that acquire, store, and provide access to information resources. The Standard also provides explicit guidance about bibliographic data elements needed for reports produced in formats not requi

36、ring covers and title pages. The Standard also describes the scope of each section of a report and offers principles for the effective communication of textual, visual, and tabular material. The establishment of technical writing standards is beyond the scope of this Standard; however, it does provi

37、de an extensive annotated bibliography of materials about technical writing and language usage and style (Appendix A). ANSI/NISO Z39.18-2005 Page viii 2005 NISO The Standard includes basic requirements for publication formats, the use of figures and tables, and the presentation of numbers and units,

38、 formulas and equations, symbols, and abbreviations and acronyms. It does not offer specific advice about electronic publishing systems that enable users to design and produce reports using a computer, appropriate software, and a laser or laser-quality printer. Because report production and reproduc

39、tion techniques use rapidly changing software products, they are not specified. Most software packages for page and report production provide instruction manuals for users. On the other hand, guidelines and considerations regarding digital publications are provided. Suggestions for improving this St

40、andard are welcome. They should be sent to the National Information Standards Organization, 4733 Bethesda Avenue, Suite 300, Bethesda, MD 20814 USA, telephone: (301) 654-2512, email: nisohqniso.org. NISO Voting Members This Standard was processed and approved for submittal to ANSI by the National In

41、formation Standards Organization. NISO approval of this Standard does not necessarily imply that all Voting Members voted for its approval. At the time it approved this Standard NISO had the following members: 3M Susan Boettcher Roger Larson (Alt) AIIM Betsy A. Fanning American Association of Law Li

42、braries Robert L. Oakley Mary Alice Baish (Alt) American Chemical Society Matthew Toussant American Library Association Betty Landesman American Society for Information Science and Technology (ASIS those in digital format, unlike paper, can be presented in several ways depending on preferences and c

43、apabilities. This revision of the Standard recognizes that guidelines for presenting digital documents differ from those applicable to ingesting digital objects into a repository. This Standard recognizes that archiving of digital documents requires a different model and new terminology. A further p

44、roblem is that paper and electronic documents have different design constraints not easily reconciled in a single standard. Insofar as it is possible to do so, this Standard recommends a Document Type Definition (DTD), a set of rules for establishing the structure of reports that may be electronical

45、ly processed through systems that include document imaging, optical character recognition, compression/decompression, and optical media storage of full text. The DTD provides suggested eXtensible Markup Language (XML), designed to improve an electronic publications functionality by providing more fl

46、exible and adaptable information identification, delivery, and presentation. ANSI/NISO Z39.18-2005 Page 2 2005 NISO 1.2 Role of Standard The guidelines in this Standard address issues related to creating, discovering, presenting, publishing, disseminating, maintaining, and preserving reports. Previo

47、us editions of the standard focused on reports printed on paper, but, with the increased availability of computers, paper is only one of the many media of publication a report can have. In addition, reports can now include digital sections as well as traditional printed text. This revised Standard a

48、ttempts to accommodate the diverse forms reports can take. Report writers should refer to the many examples throughout the Standard as models to follow rather than using the Standard as a model. 1.3 Scope of Standard This Standard will guide individuals and organizations in preparing reports. It is

49、generally couched in terms of the traditional printed report because that medium is the most concrete and common example for readers to consider and visualize. However, the Standard is expressed in such a way that adapting to other means of publication (for example, electronic formats on the Web and CD-ROMs) is recognized. Although this Standard necessarily has to consider means of distribution, facilitate methods of literature control, and accommodate methods of accessibility, it is not a standard for cataloging, describing, or preserving publications. Those roles a