Style Guidelines By: Wilmer Arellano FIU Spring 2010
Overview • E-mails • Introduction to Proposal Style • General Recommendations • Section Headings • References • Title Page
References One of the most impressive sites regarding technical writing. http://owl.english.purdue.edu/ I encourage you to visit this Website. Purdue University’s Online Writing Lab (OWL) IEEE (2006) TRANSACTIONS, JOURNALS, AND LETTERS, Information for Authors. Retrieved January 10, 2008 from IEEE Web site: http://www.ieee.org/portal/cms_docs/pubs/transactions/auinfo03.pdf C.W. POST CAMPUS APA Citation Style. Retrieved January 10, 2008 from Long Island University Web site: http://www.liunet.edu/cwis/cwp/library/workshop/citapa.htm
E-mails • When you e-mail me please: • Copy all your team members • Include team ID and course # in the subject • Include all the team names in the signature
Introduction to Proposal Style • Technical reports are used to communicate the results of: • research, • field work, • proposals and other activities. • Often, a report is the only concrete evidence of your work. • The quality of the project may be judged directly by the quality of the writing. • Most technical reports contain the same major sections, although the names of the sections vary widely, and sometimes it is appropriate to omit sections or add others. • Always check for specific requirements and guidelines before beginning to write your research report.
General Recommendations • A 12-point Times New Roman font and single line spacing should be used for the text. • Headings can be done in bold or using a larger font. • 1” page margins have to be used. • The report pages have to be numbered throughout.
General Recommendations • Start all your sections with an opening paragraph. • Do not start with a Figure, a Table or a Result • You are not writing for yourself or your instructor • You are writing for somebody you don’t know • When Possible use bulleted or numbered lists to highlight different ideas, topics or other Items. • See next example
Start all your sections with an opening paragraph. Publix’s Letter • When you write for yourself • Go to publix.
Start all your sections with an opening paragraph. Publix’s Letter • When you write for somebody you know • Go to publix and buy milk, bread, ham and sodas.
Start all your sections with an opening paragraph. Publix’s Letter • When you write for somebody you don’t know k
Start all your sections with an opening paragraph. Publix’s Letter • .
Section Headings • Primary section headings within papers are enumerated by Roman numerals and are centered above the text. For the purpose of typing the manuscript only, primary headings should be capital letters. Sample: I. PRIMARY HEADING (TEXT) • Secondary section headings are enumerated by capital letters followed by periods (“A.”, “B.”, etc.) and are flush left above their sections. The first letter of each word is capitalized. In print the headings will be in italics. Sample: A. Secondary Heading (TEXT)
Section Headings • Tertiary section headings are enumerated by Arabic numerals followed by a parenthesis. They are indented, run into the text in their sections, and are followed by a colon. The first letter of each important word is capitalized. Sample: 1) Tertiary Heading: (TEXT) • Quaternary section headings are rarely necessary but are perfectly acceptable if required. They are identical to tertiary headings except that lowercase letters are used as labels and only the first letter of the heading is capitalized. Sample: a) Quaternary Heading: (TEXT)
References • It is important to include a References section at the end of a report in which you list your other sources. • Informal or short reports may not have a references section or only a short one • while more formal reports will likely have reference sections, sometimes very lengthy ones.
References • Books:Author. (year, month day). Title. (edition) [Type of medium]. volume (issue). Available: site/path/file • Example: •  J. Jones. (1991, May 10). Networks. (2nd ed.) [Online]. Available: http://www.atm.com • Journals: Author. (year, month). Title. Journal. [Type of medium]. volume (issue), pages. Available: site/path/file • Example: •  R. J. Vidmar. (1992, Aug.). On the use of atmospheric plasmas as electromagnetic reflectors. IEEE Trans. Plasma Sci. [Online]. 21(3), pp. 876–880. Available: http://www.halcyon.com/pub/journals/21ps03-vidmar • Papers Presented at Conferences: Author. (year, month). Title. Presented at Conference title. [Type of Medium]. Available: site/path/file • Example: •  PROCESS Corp., MA. Intranets: Internet technologies deployed behind the firewall for corporate productivity. Presented at INET96 Annu. Meeting. [Online]. Available: http://home.process.com/Intranets/wp2.htp • Website • Lynch, T. (1996). DS9 trials and tribble-ations review. Retrieved October 8, 1997, from Psi Phi: Bradley's Science Fiction Club Web site: http://www.bradley.edu/campusorg/psiphi/DS9/ep/503r.html • Article from an Internet Database • Mershon, D. H. (1998, November-December). Star trek on the brain: Alien minds, human minds. American Scientist, 86, 585. Retrieved July 29, 1999, from Expanded Academic ASAP database • Last two examples from: • http://www.liunet.edu/cwis/cwp/library/workshop/citapa.htm
References • Reports and Handbooks: Author. (year, month). Title. Company. City, State or Country. [Type of Medium]. Available: site/path/file • Example: •  S. L. Talleen. (1996, Apr.). The Intranet Architecture: Managing information in the new paradigm. Amdahl Corp., CA. [Online]. Available: http://www.amdahl.com/doc/products/bsg/intra/infra/html • Computer Programs and Electronic Documents: ISO recommends that capitalization follow the accepted practice for the language or script in which the information is given. • Example: •  A. Harriman. (1993, June). Compendium of genealogical software. Humanist. [Online]. Available e-mail: HUMANIST@NYVM Message: get GENEALOGY REPORT
Title • The title page contains several main pieces of information
Double click on the white area of this slide to open the Word page that contains the Title Page. • Copy the entire Title Page and paste it into a new Word 2007 document. • My example does not have any formatting. Please use some creativity here
Copy and Paste the outline into your document • Delete information regarding to Title page • Make sure you have the most current version • http://web.eng.fiu.edu/~arellano/4010/Lecture%20II/Proposal%20Outline.doc
Remove all numbering and formatting • Select the whole outline and click Style Normal
Insert page breaks as the one inserted before after: • AKNNOWLEDGEMENT and • ABSTRACT • Center them and use Bold Capital Letters
Insert a Page Break as indicated in the next slide, just Before the first letter of each section starting with Executive Summary • This is a different type of page break
Click on the pull down arrow of breaks in the Page Layout menu and select next page
Another Example • Observe that Sub Sections must remain within their section
Select levels 1 thru 4 and: • Set for all levels : • Number Alignment Left • Aligned at: 0” • Text Indent .25” • Link levels to style headings 1, 2, 3, 4 respectively
Edit the Headings according to IEEE style Click the pull down arrow
Click on the pull down arrow of the citation button. • Insert new Citation Source so that a reference that you enter here will appear automatically in the table of references
Follow the format: • LastName1, Name1; LastName2, Name2; etc.
This time click the Citation button in the center and then select the citation from the list.
Insert figure and table captions so they will appear automatically in the list of figures
In the same form you should introduce caption for tables. Make sure that you select Table from the pull down menu