Project

profileaudriauna2$
SCML4170TechnicalReportTemplate.docx

Title of Report in Initial Capital Letters:

Times New Roman (16 points, Boldface) and

No More Than Three Lines

Your Name

Clayton State University

Date

Summary

All reports should include a one- or two-paragraph summary. This summary should stand alone (no reference to figures or tables in the text) and present the most important results of the work. The line spacing for this paragraph is to be single-spaced, with a single blank line between the heading and the text. Use block paragraph format in the Summary and throughout the paper.

Table of Contents

Summary i

1. Introduction 1

2. Second Heading X

2.1. First Subheading X

2.2. Second Subheading X

2.3. Third Subheading X

3. Third Heading X

3.1. First Subheading X

3.2. Second Subheading X

4. Fourth Heading X

5. Conclusions X

Appendix A: Title of Appendix A X

Appendix B: Title of Appendix B X

References X

Notes on Table of Contents (TOC): Number of headings and subheadings can vary for each report. The page numbers displayed in the TOC are right justified using a right tab (see ruler). Use lower-case Roman numeral page numbers (i, ii, iii, etc.) for summary and TOC pages. No page number is used on the cover page. The body of the report is page numbered using Arabic numerals (1, 2, 3, etc.).

i

1. Introduction

Use the Introduction section to orient the audience with sufficient background to understand the problem. This section should clearly address what problem is being solved, why the problem is important, and the vision/aims of the work presented in this paper.

2. Page Layout

All papers must follow the following layout:

· 8 1/2" X 11" paper

· Top and bottom margins: 1.00"

· Left and right margins: 1.00"

· Single-spacing in a single column

· No indentation - use a single blank line to separate paragraphs

· Full text justification (i.e. block format)

· Page numbers are centered at bottom of page

· No page number on cover page

· Use lower-case Roman numeral page numbers (i, ii, iii, etc.) for Summary and TOC pages.

· The body of the report (starting with Section 1. Introduction) is page numbered using Arabic numerals (1, 2, 3, etc.).

3. Style Guidelines

A few notes on writing style for technical reports:

· Use formal language. Do not use casual phrases or sayings.

· A technical report is not a short story or a mystery novel or a diary. The reader should see the key information first, then learn how it was determined. Use logical order, not chronological order

· Give enough information so that the experiment can be reproduced by another person of equal competence. Be discriminating in what is included. Be particular in detail but also conscious about not including irrelevant information.

· Be precise in the descriptions of materials, methods, measurements, and means of analysis.

· Write in 3rd person. Do not use words such as “you,” “I,” “our,” “we,” or “my.”

· Avoid writing in the passive voice. Write in the active voice. The following websites address the subject of passive and active voices in technical writing.

· http://owl.english.purdue.edu/handouts/grammar/g_actpass.html

· http://www.unc.edu/depts/wcweb/handouts/passivevoice.html

· Avoid writing in past tense. Write in present tense unless discussing results reported in earlier papers. Use consistent tense throughout the paper.

· Do not use contractions such as “don’t,” “can’t,” “won’t,” or “couldn’t.”

· Avoid using footnotes.

· Explain abbreviations before use. Expand all acronyms on first use.

· Numbers ten or less are spelled out: "It consists of three fields", not "3 fields".

· Be sure to proofread and carefully check spelling and grammar.

· Here are some links to technical report writing guidelines, tips, and example reports.

· http://owl.english.purdue.edu/owl/

· http://writing.colostate.edu/guides/documents/ce-trpt/

4. Text Sections and Headings

At least one paragraph of text should follow a main heading before a sub-heading occurs.

4.1. Text Sections and Headings

Text should be organized into sections and subsections, with an Introduction and a Conclusions section being advisable. A single line should separate paragraphs; no indentation should be used. Font guidelines are as follows:

· Section Headings: Numbered, 14 point, bold, Upper and Lower Case, left-justified; leave one blank line above only.

· Section Sub-headings: Numbered, 12 point, bold, Upper and Lower Case, left-justified; leave one blank line above only. If sub-headings are used, there must at least two sub-headings.

· Regular text: 12 pt. Times New Roman, full justified, with a single line between paragraphs. Text is single spaced.

· Do not allow a heading or sub-heading to stand as a widow line at the bottom of a page. If this situation occurs, insert a page break before the heading or sub-heading.

4.2. Bullets

Bullet guidelines are as follows:

· First level bullet.

· Second level bullet.

· Third level bullet.

5. Figures, Tables, and Their Captions

Tables and figures should be included in the main text (see Figure 1 and Table 1), as close to the point of their introduction as possible. Never insert a table or figure in the middle of a paragraph; tables and figures should appear after the end of the paragraph in which it was initially introduced in the text. It is noted that figure and table numbering should be independent. Captions guidelines are as follows:

· Figure captions: 12 point Times New Roman, centered; place below the figure, leave one blank line above and below. For example, see Figure 1 below.

· Table caption: 12 pt. Times New Roman, centered; place above the table, leave one blank line above only. For example, see Table 1 below.

Figure 1: Example figure for demonstration

This is an example paragraph to demonstrate the guidelines for the figure and table captions.

Table 1: Example table for demonstration

Conservative

Epoch

Improvement (%)

Six epochs

Federation run time

1.1

0.44

62.8

Number of time advance messages exchanged

9470

1027

89.2

Number of checking messages exchanged

34302

23533

31.4

Arrange bulky and repetitive data in tables and graphs, and refrain from regurgitating in the text all of the data presented in the graphics. Explain the graphics but do not merely repeat them verbatim in the body of the report. Direct the reader to the important and most interesting parts of the table or graph.

6. Equations

Equations should be indented and numbered consecutively throughout the entire paper, with the number in parentheses, positioned flush to the right margin. Leave one blank line both above and below the equation. Equations should be prepared with an Equation Writer (e.g. Microsoft Equation 3.0). See Equation (1) below for the demonstration.

(1)

Be sure to define all variables used in equations. If an equation only contains a few variables, these can be defined within the body of the text immediately before or after the equation. However if several variables are used in an equation, they should be defined outside the text. As an example, see equation (2).

(2)

Where: EOQ = Economic Order Quantity (units)

K = fixed ordering cost ($)

λ= annual demand (units/yr)

h = inventory holding cost ($/unit/yr)

Do not ‘write out’ the equation in the text but rather explain the general purpose of each equation. For example, do not write “equation (1) shows the EOQ is the square root of two times the fixed ordering cost, K, multiplied by the annual demand, λ, divided by the inventory holding cost, h.”

References

I prefer you use the APA citation/reference style. Please see the following websites for the proper way to reference sources both within the text and in the reference list at the end of the technical paper (and, yes, I know these websites are not referenced correctly according to APA guidelines).

· http://www.library.cornell.edu/resrch/citmanage/apa

· http://owl.english.purdue.edu/owl/resource/560/01/

I

N

T

E

R

N

E

T

~

I

N

T

R

A

N

E

T

Interface DLL

Legacy

Simulation

Model

Interface DLL

Legacy

Simulation

Model

XML

Encoder

/ Decoder

XML

Encoder

/ Decoder

Data

Repository

Time

Management

Data

Management

T

T

R

R

A

A

N

N

S

S

A

A

C

C

T

T

I

I

O

O

N

N

C

C

O

O

O

O

R

R

D

D

I

I

N

N

A

A

T

T

O

O

R

R

Look

Ahead

Look

Ahead

XML

Encoder

Decoder

image1.bmp

TRANSACTION

COORDINATOR

Data

Management

Time

Management

XML Encoder

/ Decoder

XML Encoder

/ Decoder

Data

Repository

Legacy Simulation Model

Interface DLL

Legacy Simulation Model

Interface DLL

I

N

T

E

R

N

E

T

~

I

N

T

R

A

N

E

T

Look Ahead

Look Ahead

XML

Encoder Decoder

h

K

EOQ

l

2

=