sample epri technical reportmydocs.epri.com/.../2012_eprireportsample.doc · web viewtitle sample...

23
Sample EPRI Technical Report Style Requirements for Research Contractors [Product ID #] Final Report, Month 2012 EPRI Project Manager (and other EPRI staff contributing to this report, if desired) J. Smith ELECTRIC POWER RESEARCH INSTITUTE 3420 Hillview Avenue, Palo Alto, California 94304-1338 PO Box 10412, Palo Alto, California 94303-0813 USA 800.313.3774 650.855.2121 [email protected] www.epri.com

Upload: duongtram

Post on 09-Jun-2018

226 views

Category:

Documents


1 download

TRANSCRIPT

Page 1: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

Sample EPRI Technical ReportStyle Requirements for Research Contractors

[Product ID #]

Final Report, Month 2012

EPRI Project Manager (and other EPRI staff contributing to this report, if desired)J. Smith

ELECTRIC POWER RESEARCH INSTITUTE3420 Hillview Avenue, Palo Alto, California 94304-1338 PO Box 10412, Palo Alto, California 94303-0813 USA

800.313.3774 650.855.2121 [email protected] www.epri.com

Page 2: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

DISCLAIMER OF WARRANTIES AND LIMITATION OF LIABILITIES

THIS DOCUMENT WAS PREPARED BY THE ORGANIZATION(S) NAMED BELOW AS AN ACCOUNT OF WORK SPONSORED OR COSPONSORED BY THE ELECTRIC POWER RESEARCH INSTITUTE, INC. (EPRI). NEITHER EPRI, ANY MEMBER OF EPRI, ANY COSPONSOR, THE ORGANIZATION(S) BELOW, NOR ANY PERSON ACTING ON BEHALF OF ANY OF THEM:

(A) MAKES ANY WARRANTY OR REPRESENTATION WHATSOEVER, EXPRESS OR IMPLIED, (I) WITH RESPECT TO THE USE OF ANY INFORMATION, APPARATUS, METHOD, PROCESS, OR SIMILAR ITEM DISCLOSED IN THIS DOCUMENT, INCLUDING MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, OR (II) THAT SUCH USE DOES NOT INFRINGE ON OR INTERFERE WITH PRIVATELY OWNED RIGHTS, INCLUDING ANY PARTY'S INTELLECTUAL PROPERTY, OR (III) THAT THIS DOCUMENT IS SUITABLE TO ANY PARTICULAR USER'S CIRCUMSTANCE; OR

(B) ASSUMES RESPONSIBILITY FOR ANY DAMAGES OR OTHER LIABILITY WHATSOEVER (INCLUDING ANY CONSEQUENTIAL DAMAGES, EVEN IF EPRI OR ANY EPRI REPRESENTATIVE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES) RESULTING FROM YOUR SELECTION OR USE OF THIS DOCUMENT OR ANY INFORMATION, APPARATUS, METHOD, PROCESS, OR SIMILAR ITEM DISCLOSED IN THIS DOCUMENT.

REFERENCE HEREIN TO ANY SPECIFIC COMMERCIAL PRODUCT, PROCESS, OR SERVICE BY ITS TRADE NAME, TRADEMARK, MANUFACTURER, OR OTHERWISE, DOES NOT NECESSARILY CONSTITUTE OR IMPLY ITS ENDORSEMENT, RECOMMENDATION, OR FAVORING BY EPRI.

THE FOLLOWING ORGANIZATION(S), UNDER CONTRACT TO EPRI, PREPARED THIS REPORT:

Company Name

NOTE

For further information about EPRI, call the EPRI Customer Assistance Center at 800.313.3774 or e-mail [email protected].

Electric Power Research Institute, EPRI, and TOGETHER…SHAPING THE FUTURE OF ELECTRICITY are registered service marks of the Electric Power Research Institute, Inc.

Copyright © 2012 Electric Power Research Institute, Inc. All rights reserved.

Page 3: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

ACKNOWLEDGMENTS

The following organization(s), under contract to the Electric Power Research Institute (EPRI), prepared this report:

Organization 1AddressCity, State Zip

Principal InvestigatorI. Last

Organization 2Address 2City, State Zip

Principal InvestigatorI. Last

This report describes research sponsored by EPRI. <In most cases, reports should indicate EPRI only as the “sponsor.” If there is a desire to acknowledge funders, insert the following sentence: EPRI would like to acknowledge the support of the following organizations: [list]>.

Insert any additional acknowledgment statements here.

This publication is a corporate document that should be cited in the literature in the following manner:

Title of Document: Subtitle. EPRI, Palo Alto, CA: <Year>. <Product ID#>.

iii

Page 4: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

ABSTRACT

The abstract is a required brief summary of the research report. It highlights the objectives of the reported research. It briefly describes the steps taken to conduct the work and summarizes its results in a general manner and potential applications, if any. The abstract will be a public document available on epri.com. It must not contain any confidential, proprietary or trade secret information belonging to EPRI or to any other party, or any information subject to Export Control. Limit text to one page in length. Apply EPRI Normal style.

KeywordsInsert the keywords here.

v

Page 5: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

EXECUTIVE SUMMARY

The Executive Summary of the report should highlight and communicate key findings to members and the public. 1

It can include:

Brief statement on why this technology is the subject of research. What’s included in the report (not an exhaustive list, but rather the focus of the report).

The new knowledge, take aways, and most important findings (this can be short; just need the main results from the research).

Introduction

1. Background/context with basic definition of the research question covered

2. Summary or foreshadowing of report body as appropriate

Research Overview

1. How it works and applications

2. Standards or safety issues

3. Issues related to interoperability

Conclusions

1. What was learned and what are the applications of the new learning

2. What does it take for the research result/new learning to be widely adopted

3. What it means for the consumer, the industry and the society in general

4. R&D needs and EPR

I R&D plans, if applicable

1 testing

vii

Page 6: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

ADDITIONAL FRONT MATTER SECTION(S)

To create additional Front Matter sections such as this, place the cursor to the left of the paragraph mark at the beginning of the previous Section Break format marker, select Insert Break, choose Section Break Types Odd Page.

Type the desired Front Matter Section Title and hit Return twice. Highlight the Front Matter Section Title and apply EPRI Section Title Style.

Place the cursor to the left of the second paragraph mark, begin typing text, then apply EPRI Normal Style to the text.

Subheading (apply EPRI Subheadings Style)

Any subheadings created in Front Matter Sections (other than the Product Description/Report Summary) must be styled with EPRI Subheadings Style.

To delete this section, highlight the Section Title through and including the section break below and hit the Delete key.

If the report contains a Product Description or Report Summary, place it here, followed by any other appropriate Front Matter material such as a glossary.

ix

Page 7: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

CONTENTS

1 CHAPTER 1................................................................................................................1-1Inserting Figures........................................................................................................1-1

Heading 2...................................................................................................................1-2

Heading 3..............................................................................................................1-3

Heading 4.........................................................................................................1-3

Heading 5.....................................................................................................1-4

Creating Additional Chapters.....................................................................................1-4

2 REFERENCES AND BIBLIOGRAPHIES...................................................................2-1References.................................................................................................................2-1

Bibliography...............................................................................................................2-1

Glossaries and Indexes..............................................................................................2-2

Glossaries.............................................................................................................2-2

Indexes..................................................................................................................2-2

A APPENDIX.................................................................................................................A-1Heading 7 (Appendix Heading)..................................................................................A-1

Heading 8 (Appendix Heading).............................................................................A-2

Heading 8 (Appendix Heading).............................................................................A-2

xi

Page 8: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

xiii

Page 9: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

LIST OF FIGURES

Figure 1-1 First Figure Caption.......................................................................................1-2Figure 1-2 Second Figure Caption..................................................................................1-3Figure A-1 First Appendix Figure Caption......................................................................A-1Figure A-2 Second Appendix Figure Caption.................................................................A-1

xv

Page 10: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

LIST OF TABLES

Table 1-1 First Table Caption.........................................................................................1-3Table 1-2 Second Table Caption....................................................................................1-4Table A-1 First Appendix Table Caption........................................................................A-2Table A-2 Second Appendix Table Caption...................................................................A-2

xvii

Page 11: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

1 CHAPTER 1

Type text here. Apply EPRI Normal Style. Paragraph spacing is built into all EPRI styles, so there is no need to hit return more than once to go from paragraph to paragraph or paragraph to heading.

Inserting Figures

To insert a figure, go to Insert/Picture and locate and select a picture, and choose the method of insertion. Please turn off any Float Over Text feature; figures should always be in line with text.

After the figure has been placed, it needs a Figure number and a Caption:

Hit return once, and go to Reference/Insert Caption.

When in the Chapter sections (as opposed to the Appendix sections), choose the first entry for Figure from the list. It should be numbered automatically to include the chapter number and sequence number. (If it is not, click on the Numbering button, and click Include Chapter Number.)

Click OK, then enter a soft return (shift + enter), and type the Caption.Captions should be in Title Case (first letter capitalized except for prepositions).

Do not modify Figure numbering to include additional characters such as Figure 2-1a, or Figure 2-1(a), as the List of Figures will not work properly.

1

Page 12: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

Figure 1-1First Figure Caption

Heading 2

Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip.

List (Bulleted)

List (Bulleted)

List (Bulleted)

Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.

2

Page 13: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

Chapter 1

Figure 1-2Second Figure Caption

5. List (Numbered)

6. List (Numbered)

7. List (Numbered)

Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.

Table 1-1 First Table Caption

Table Head Table Head

Table Text Table Text

Table Text Table Text

Table Text Table Text

Heading 3

Nam liber tempor cum soluta nobis eleifend option congue nihil imperdiet doming id quod mazim placerat facer possim assum. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.

Heading 4

Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis

3

Page 14: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

References and Bibliographies

autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea comodo consequat vulputate velit esse molestie.

Table 1-2Second Table Caption

Table Head Table Head Table Head Table Head

Table Text Table Text Table Text Table Text

Table Text Table Text Table Text Table Text

Table Text Table Text Table Text Table Text

Heading 5

Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Nam liber tempor cum soluta nobis eleifend option congue nihil imperdiet doming id quod mazim placerat facer possim assum.

Creating Additional Chapters

To create additional Chapters, place the cursor to the left of the paragraph mark at the beginning of the previous Section Break format marker, select Page Layout, choose Section Break Odd Page.

Type the desired Chapter Title and insert a soft return (shift + enter). Highlight the Chapter Title and apply Heading 1, Chapter Level Style.

Hit return and begin typing text.

4

Page 15: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

2 REFERENCES AND BIBLIOGRAPHIES

References

A list of references, either at the end of each report section or in a separate section at the end of the report, is preferred to a bibliography. In proceedings, references are presented at the end of each technical paper. Number each entry using a number followed by a period.

Reference citations may occur anywhere in a sentence. The citation precedes all punctuation except dashes. Indicate the citation using a bracketed number: [1].

Entries in reference lists are single-spaced, with one line of space between entries. Numbered references should correspond to text citations. The following examples indicate EPRI’s style preferences:

1. U.S. Department of Commerce. Bureau of the Census. Statistical Abstract of the United States, 1990. 110th ed. Government Printing Office, Washington, D.C. 1977. [government publication]

2. Robert Jastrow, William Nirenberg, and Frederick Seitz. Scientific Perspectives in the Greenhouse Problem. Marshall Press, Ottawa, IL 1990, pp. 71–98. [book]

3. “The Push for Advanced Batteries.” Customer Systems Division Report, EPRI Journal, April/May 1991, p. 36. [magazine article]

4. Feedwater Heater Survey. EPRI, Palo Alto, CA: 1991. G57417. [report]

5. B. S. Phull, T. S. Lee, N. H. Martin, and B. C. Syrett, “Corrosion Inhibitors for FGD Systems,” Paper No. 252, presented at the NACE Annual Conference CORROSION 187, San Francisco, CA (March 1987). [conference paper]

6. B. S. Phull, T. S. Lee, N. H. Martin, and B. C. Syrett, “Corrosion Inhibitors for FGD Systems,” Materials Performance. Vol. 27, No. 2, p. 12 (1988). [scientific journal]

Bibliography

A bibliography provides the reader with a general reading list of related materials. It is a separate section at the end of the report and takes a first-level head. Bibliography entries are not numbered, but listed alphabetically by author.

Entries in the bibliography are listed alphabetically by author and single-spaced, with one line of space between entries. Examples are shown below.

1

Page 16: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

Buringh, P. “Organic Carbon in Soils of the World.” The Role of Terrestrial Vegetation in the Global Carbon Cycle. New York: Wiley, 1984.

Schwartz, Peter. The Art of the Long View. New York: Doubleday, 1991.

Glossaries and Indexes

Glossaries and indexes are optional.

Glossaries

A glossary is a useful tool in a publication containing unfamiliar terms. Words to be defined should be arranged in alphabetical order, each on a separate line and followed by its definition. Examples are shown below:

acid-free paper. Paper having a pH of 7, or close to 7.

adhesive binding. A method of binding that employs glue instead of stitching to hold the pages together.

alteration. A change from the manuscript copy introduced in proof.

Indexes

An index consists of entries that include a heading, locators (page numbers), subentries, and cross-references as needed. The heading of an index entry is normally a noun or noun phrase. The first word of a heading is normally capitalized only if capitalized in the text. Examples are shown below:

agricultural collectivization, 143-46, 198

Aron, Raymond, 312-14

Bloomsbury group, 269

capitalism, American commitment to, 383

cold war, 396-437

2

Page 17: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

A APPENDIX

Appendixes present material too detailed to be included in the main report text–for example, computer printouts or lengthy comparative data.

Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum.

Figure A-1 First Appendix Figure Caption

Heading 7 (Appendix Heading)

Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh eLorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.

Figure A-2Second Appendix Figure Caption

1

Page 18: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.

Table A-1First Appendix Table Caption

Table Head Table Head

Table Text Table Text

Table Text Table Text

Table Text Table Text

Heading 8 (Appendix Heading)

Nam liber tempor cum soluta nobis eleifend option congue nihil imperdiet doming id quod mazim placerat facer possim assum. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.

Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.

Table A-2Second Appendix Table Caption

Table Head Table Head

Table Text Table Text

Table Text Table Text

Table Text Table Text

Heading 8 (Appendix Heading)

Nam liber tempor cum soluta nobis eleifend option congue nihil imperdiet doming id quod mazim placerat facer possim assum. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla

2

Page 19: Sample EPRI Technical Reportmydocs.epri.com/.../2012_EPRIReportSample.doc · Web viewTitle Sample EPRI Technical Report Subject 10XXXXX Author Electric Power Research Institute (EPRI)

Appendix

facilisi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.

3