This action might not be possible to undo. Are you sure you want to continue?
REPORT FORMAT AND STYLE GUIDE
REPORT REQUIREMENTS • • • The project group must submit the final report electronically. Textual material should be created in a format compatible with Microsoft Word 2000. Though, other wordprocessing programs may be converted, results may vary. Reports that are to be published on the web must be submitted as either a PDF or HTML file. If you are unable to meet these electronic transfer requirements, before submitting your report please contact the course instructor.
(One of the most rigorous reporting requirements comes from the New York State Energy Research and Development Authority – NYSERDA, www.NYSERDA.Org. The following is modified from http://www.nyserda.org/exhibitc.pdf, Nov. 2003) Students need not include all sections, but should use this as a guide to the detail of their own choosing. However, each student should familiarize themselves with the details for future reference. PURPOSE This document explains how to prepare a technical report, describes editorial and production procedures and gives electronic data transfer information. COPYRIGHTS All material borrowed or adapted from other sources should be properly identified (i.e., document, source, date, and page). The project group must obtain and include in an appendix the copyright owner's written permission to use copyrighted illustrations, tables, or substantial amounts of text from another publication. REPORT FORMAT AND SEQUENCE The following items are required in all technical reports and should be paginated in the following sequence: • • • • • • • Title page (no page number): as recorded on the web Notice (no page number): see below Abstract (iii): as recorded on the web Acknowledgments (optional) (iv) Table of Contents, including listings of figures and tables (v to vii) Executive Summary (S-1…) Report Body (Section – Page Number) From EE402 Proposal: Technical Content o Identification and Significance of Problem o Technical Background o Technical Objectives Added EE402 report content o Summary of design approach o Design and documentation Design equations, schematics, etc. Photo documentation o Test plan Identification of performance metrics Test approach o Design and Test Results
Page 1 Spring 2004
described.Report title and type of report (i. process. method. disclosed. estimated return on investment Appendix – Supporting Documents o EE402 Project Benefits – What did you gain from this experience? o Work Plan Task list – original and final Timeline – original and final o Project cost (Your actual costs) o • References or Bibliography Title Page The following information is required (see sample on last page): . investigative methods used. injury. and their page numbers. final. When there are project cosponsors. second-level headings. as to the fitness for particular purpose or merchantability of any product.. process. and distributing the report through NTIS. registering. the use of information contained. and reference to any specific product. interim. completeness. If the report contains five or more figures or tables. or other information contained. or referred to in this report.Project Group members . or damage resulting from. and research conclusions or applications. and the project group make no representation that the use of any product.Project Group number or identifier Notices A legal notice or disclaimer is often required for public reports. or service. Abstract and Key Words – page [iii] An abstract is a brief.e. 200-word description of project objectives. the Sponsors and the State of New York make no warranties or representations. Four to six precise descriptors are generally sufficient for indexing. The opinions expressed in this report do not necessarily reflect those of the Sponsors or the State of New York. required resources. expressed or implied. methods. Thirdlevel headings also may be listed. service. Further. or summary) . etc. Table of Contents and Lists of Figures and Tables – pages [v. apparatus. titles. or method does not constitute an implied or expressed recommendation or endorsement of it. A list of key words that describe the project and identify the major research concept should be submitted with the report.Project Group name and contact information . The following samples are boxed only to set them apart in this document. vii. or accuracy of any processes. apparatus. ix. the State of New York.EE 402 Report Guide Commercialization strategy (optional) Anticipated markets. or the usefulness. or occurring in connection with. The Sponsors. Prof.Name of Technical Advisor(s) . DCHopkins Page 2 Spring 2004 .] The Table of Contents should list section numbers. described. This information will be used if the report is registered with the National Technical Information Service (NTIS). or referred to in this report. they should be listed using the style of the Table of Contents. Acknowledgments (optional) – page [iv] Acknowledgments precede the contents and should be no longer than two paragraphs. use the following notice: NOTICE This report was prepared by _____ in the course of performing work for and sponsored by the State of New York and the _____ (hereafter the "Sponsors"). or other information will not infringe privately owned rights and will assume no liability for any loss. disclosed.
the general public. many of whom lack a technical background. legislators. Page 3 Spring 2004 Prof. 1 inch top and bottom. These may include industry executives. DCHopkins .Margins should be 1. government officials. The Summary may be the only part of the technical report closely read by a number of people. should be written for a general audience. [EXAMPLE] TABLE OF CONTENTS Section EXECUTIVE SUMMARY 1 IDENTIFICATION AND SIGNIFICANCE OF PROBLEM 2 TECHNICAL BACKGROUND 3 TECHNICAL OBJECTIVES 4 SUMMARY OF DESIGN APPROACH 5 DESIGN AND DOCUMENTATION [TASK 1] [TASK 2] 6 RESULTS TEST PLAN DESIGN RESULTS APPENDIX A – PROJECT BENEFITS APPENDIX B – WORK PLAN TASK LIST TIMELINE APPENDIX C – PROJECT COSTS Page S-1 1-1 2-1 3-1 4-1 5-1 556-1 66A-1 B-1 C-1 [EXAMPLE TABLE OF] FIGURES Figure 1-1 Comparative Use Per Cubic Bed 2-1 View of Community from South 2-2 TEAM MEMBERS Page 1-2 2-1 2-5 COPY • Page format: .25 inches left and right.EE 402 Report Guide Executive Summary – page [S-1] The Summary. which immediately precedes the body of the text. and media representatives. The Summary should be 500-1000 words long.
the text is at the left margin.Bulleted items should be indented left and right.). . • • • HEADING STYLES The heading styles illustrated below should be used. with no indentation (except for fifth-level headings. etc.5 lines.)." not zero. 2-1. followed by the acronym in parentheses. etc. etc. odd-numbered page (e. Cite a source if the tabular material or figure content has not been generated by the project group.) FIRST-LEVEL HEADING Section 1 INTRODUCTION The heading is upper case.. boldfaced. at the left margin. Times Roman. etc. TABLES AND FIGURES • • • • Tables and figures must be numbered sequentially and titled individually. DCHopkins . the text is below the heading. tables.e. . Percentages should be written as follows: 1%. The heading is upper and lower case. Distinguish tabular material from the text. centered. • • • • • Material borrowed or adapted from external sources must be identified (i.If a typographical bullet is unavailable. The text continues on the same line as the heading. or text taken from another publication must be submitted with the report. Do not use contractions. and boldfaced. and underscored. Avoid half-page and one-sentence paragraphs. Arial. and figures should be in a sans-serif font (i. at the left margin. and page).Use left-hand justification only. All new sections should begin on a right-hand.Text should be in a 10-point serif font (i. captions.e. the text is at the left margin. (Only section headings should be numbered. The heading is upper and lower case. document.There should be two returns between a paragraph and the next heading.Block-style paragraphs should be used. see Heading Styles. . which should be blocked on the left.One blank line should precede and follow a list.. with a period at the end." Indented lists of material should be set off with bullets: . 76%. . Helvetica. date. When referring to a specific figure or table. boldfaced. . 1-1. Written permission to use copyrighted illustrations. and boldfaced. Third-Level Heading The heading is upper and lower case. Bookman. source. spell out and capitalize the words "Figure" and "Table.). below).Spacing should be 1.EE 402 Report Guide . and underscored. tables.. A-1. indented.. at the left margin. The remaining text goes back out to the left margin. Fifth-Level Heading. Page 4 Spring 2004 Prof. The text continues on the same line. boldfaced. at the left margin. Place tables and figures as close as possible to the text in which they are mentioned.g. Acronyms must be spelled out the first time used. printed on one side of the paper. with the remaining text indented left and right. the bullet is a lower case "o. . and underscored with a period at the end. Fourth-Level Heading.e. SECOND-LEVEL HEADING The heading is upper case.
a source should always be cited. Demand-Side Management Options in New York State. Color artwork and photos are encouraged. Author should list bibliographic entries alphabetically. the table source should be noted with an asterisk and footnoted. Figure captions should be typed in boldface. 1958. R.Table 1 details demand-side management options. clear halftones (black-and-white photographs) may be used.Figure 1. Prof. with the following guidelines. ." in the text. New York: Bowker. Scientific. Use "Figure 1. 1. as well as for captions.g. and Technical Books Published in the United States of America. Illinois) should be used for reference listings and bibliographies. Black-and-white line drawings or good-quality. The figure source should appear after the caption (e. the demand-side management program offers numerous options. . Medical. DCHopkins Page 5 Spring 2004 .As shown in Figure 1.EE 402 Report Guide • • Figure captions should be complete sentences when appropriate. Chicago. Examples: ." not "Fig. but will most often be printed in black-and-white. Photographs and drawings should be limited in number. Source: Lawrence Berkeley Laboratory).R.. • • • REFERENCES AND BIBLIOGRAPHIES The format in Manual of Style (University of Chicago Press. 2d ed. Unless generated by the project group." or "Table 1. as follows: Hawkins.
E.E. INC. NY Lawrence J. Pakenas. Funigiello.EE 402 Report Guide SAMPLE TITLE PAGE CITY OF LOCKPORT INFLUENT HYDROPOWER FEASIBILITY STUDY Final Report Prepared for THE NEW YORK STATE ENERGY RESEARCH AND DEVELOPMENT AUTHORITY Albany. P. NY Vincent J. Senior Project Manager Prepared by CITY OF LOCKPORT Lockport. DCHopkins Page 6 Fall 2003 . NY Michael Diel Project Manager and M ALCOLM PIRNIE. Project Manager 4311-ERTER-MW-97 NYSERDA Report 98-11 July 1998 Prof. Buffalo. P.