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
This information will be used if the report is registered with the National Technical Information Service (NTIS). DCHopkins Page 2 Spring 2004 . expressed or implied. The following samples are boxed only to set them apart in this document. the use of information contained. and their page numbers. or other information will not infringe privately owned rights and will assume no liability for any loss. described. Thirdlevel headings also may be listed. or the usefulness. investigative methods used.. 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): . final. service. or referred to in this report. or accuracy of any processes. or other information contained. and the project group make no representation that the use of any product.Project Group name and contact information . the State of New York. etc. vii. apparatus.Project Group members . and research conclusions or applications.Report title and type of report (i. or occurring in connection with.] The Table of Contents should list section numbers. described. or service.Project Group number or identifier Notices A legal notice or disclaimer is often required for public reports. process. Abstract and Key Words – page [iii] An abstract is a brief. they should be listed using the style of the Table of Contents. 200-word description of project objectives. When there are project cosponsors.Name of Technical Advisor(s) . the Sponsors and the State of New York make no warranties or representations. completeness. titles.e. as to the fitness for particular purpose or merchantability of any product. The Sponsors. injury. required resources. Four to six precise descriptors are generally sufficient for indexing. method. ix. and distributing the report through NTIS. 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 referred to in this report. or damage resulting from. A list of key words that describe the project and identify the major research concept should be submitted with the report. and reference to any specific product. Table of Contents and Lists of Figures and Tables – pages [v. methods.EE 402 Report Guide Commercialization strategy (optional) Anticipated markets. or method does not constitute an implied or expressed recommendation or endorsement of it. interim. Acknowledgments (optional) – page [iv] Acknowledgments precede the contents and should be no longer than two paragraphs. second-level headings. If the report contains five or more figures or tables. Further. disclosed. process. registering. or summary) . disclosed. apparatus. The opinions expressed in this report do not necessarily reflect those of the Sponsors or the State of New York. Prof.
legislators. many of whom lack a technical background. Page 3 Spring 2004 Prof.25 inches left and right.EE 402 Report Guide Executive Summary – page [S-1] The Summary. The Summary should be 500-1000 words long. the general public. These may include industry executives. DCHopkins . should be written for a general audience. and media representatives.Margins should be 1. 1 inch top and bottom. [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: . which immediately precedes the body of the text. The Summary may be the only part of the technical report closely read by a number of people. government officials.
and figures should be in a sans-serif font (i.Use left-hand justification only. etc. and boldfaced.. document.Text should be in a 10-point serif font (i. The text continues on the same line. All new sections should begin on a right-hand. SECOND-LEVEL HEADING The heading is upper case. Helvetica. The heading is upper and lower case.). boldfaced.Bulleted items should be indented left and right. etc. see Heading Styles. Distinguish tabular material from the text..5 lines. at the left margin. the bullet is a lower case "o. The heading is upper and lower case. Third-Level Heading The heading is upper and lower case. When referring to a specific figure or table. with the remaining text indented left and right.) FIRST-LEVEL HEADING Section 1 INTRODUCTION The heading is upper case.. Fifth-Level Heading. .Block-style paragraphs should be used. odd-numbered page (e. and underscored. at the left margin. Written permission to use copyrighted illustrations.e." not zero.). (Only section headings should be numbered. . at the left margin.There should be two returns between a paragraph and the next heading." Indented lists of material should be set off with bullets: . • • • • • Material borrowed or adapted from external sources must be identified (i. Acronyms must be spelled out the first time used. the text is at the left margin. . Arial. with a period at the end.EE 402 Report Guide . Do not use contractions.. tables. Fourth-Level Heading. DCHopkins . and underscored with a period at the end. and underscored. Page 4 Spring 2004 Prof. 76%. . the text is at the left margin. followed by the acronym in parentheses. indented. . etc. Avoid half-page and one-sentence paragraphs. The remaining text goes back out to the left margin. at the left margin. centered. TABLES AND FIGURES • • • • Tables and figures must be numbered sequentially and titled individually. A-1.One blank line should precede and follow a list. printed on one side of the paper. date.e. boldfaced. etc. and page). 1-1. Percentages should be written as follows: 1%. . or text taken from another publication must be submitted with the report.e. with no indentation (except for fifth-level headings. • • • HEADING STYLES The heading styles illustrated below should be used. which should be blocked on the left. Cite a source if the tabular material or figure content has not been generated by the project group.Spacing should be 1. source. spell out and capitalize the words "Figure" and "Table. Place tables and figures as close as possible to the text in which they are mentioned. the text is below the heading. boldfaced.g. below). Times Roman. tables. 2-1.If a typographical bullet is unavailable. Bookman. The text continues on the same line as the heading. and boldfaced. captions.).
the demand-side management program offers numerous options. Unless generated by the project group. as follows: Hawkins. .. Chicago. the table source should be noted with an asterisk and footnoted. 2d ed. DCHopkins Page 5 Spring 2004 ." not "Fig.EE 402 Report Guide • • Figure captions should be complete sentences when appropriate. New York: Bowker.As shown in Figure 1.g. a source should always be cited.Table 1 details demand-side management options. Use "Figure 1. clear halftones (black-and-white photographs) may be used. Color artwork and photos are encouraged. Figure captions should be typed in boldface. as well as for captions. with the following guidelines. and Technical Books Published in the United States of America. R.Figure 1." or "Table 1. 1958. Medical. . Source: Lawrence Berkeley Laboratory). Black-and-white line drawings or good-quality. The figure source should appear after the caption (e. Scientific. but will most often be printed in black-and-white. Examples: . Demand-Side Management Options in New York State." in the text. • • • REFERENCES AND BIBLIOGRAPHIES The format in Manual of Style (University of Chicago Press. Illinois) should be used for reference listings and bibliographies. Prof. 1.R. Photographs and drawings should be limited in number. Author should list bibliographic entries alphabetically.
Funigiello.E.E. Project Manager 4311-ERTER-MW-97 NYSERDA Report 98-11 July 1998 Prof. DCHopkins Page 6 Fall 2003 . NY Michael Diel Project Manager and M ALCOLM PIRNIE. P. Senior Project Manager Prepared by CITY OF LOCKPORT Lockport.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. NY Vincent J. Pakenas. INC. P. NY Lawrence J. Buffalo.
This action might not be possible to undo. Are you sure you want to continue?
We've moved you to where you read on your other device.
Get the full title to continue reading from where you left off, or restart the preview.