You are on page 1of 14

Documentation in Engineering Writing

When you borrow materials from other sources you have to document and reference these materials, otherwise you are plagiarizing (copying and stealing), and in this case you might be law suited by the owner of this material. Also, it is plagiarism if you are using the same words, sentences, or paragraphs of the others writings. You should use your own words.
CH 11
1

Documentation in Engineering Writing Systems used for sources documentation


There are many systems used for documentation. One of these systems (which we are going to use) is the one used by the Institute of Electrical and Electronic Engineers (IEEE). There are also:

MLA system (Modern Language Association) CM (Chicago Manual) CBE (Council of Biology Editors) APA (American Psychological Association)
CH 11
2

Documentation in Engineering Writing Documentation using IEEE


Inside the body of your text (CITATION) Refer to the source of the borrowed material by using consecutive numbers inside brackets at the end part of the information you borrowed. These numbers start with [1] for the first source you used. The increase in the earth temperature was found to be affected by the increase in CO2 concentration [3]. You can inter reference number inside the sentence. The results of stress analysis in [4] show that According to Ali [7], Salem says
CH 11
3

Documentation in Engineering Writing Documentation using IEEE


You need also to include the page numbers if you are citing from references other than books or articles. [8, pp. 27] or [11, pp. 24-28] or [5, pp. 9; 12, pp. 14-17; 15, pp. 5,11-15]. Use semicolons to separate information from many reference in the same paragraph. At the end of quotation mark, use the period punctuation at the end of the reference. Poverty and technology never work together, [11,p.10].
CH 11
4

Documentation in Engineering Writing Documentation using IEEE

CH 11

Documentation in Engineering Writing Documentation using IEEE

CH 11

Documentation in Engineering Writing Format of the reference page (IEEE System)


List the sources in numerical order according to their appearance in the text

The initial of the first names of the authors appears in the list. J. Lee, or A. M. Rice
Single space between the lines of same reference and double space between different references List the reference just one time even if you use the same reference in your text many 7 CH 11 times

Documentation in Engineering Writing Format of the reference page (IEEE System)

CH 11

Documentation in Engineering Writing Format of the reference page (IEEE System)

CH 11

Documentation in Engineering Writing Format of the reference page (IEEE System)

CH 11

10

Ethics in Engineering Writing


Copyright : Should not copy/use the others properties without permissions from the author Playing with the results: - Do not use fictitious data in your work or research to get the results that you want - Don not play with the results of your research or work You should not hide improper information: - Regarding harmful products - Wrong and dangerous design 11 CH 11 - Job application and resumes

Ethics in Engineering Writing


When you write instructions or procedures, they should be clear to the readers Do not omit safety warnings: like safety warnings written inside the manuals of equipments, products, designs, and so

CH 11

12

Ethics in Engineering Writing

CH 11

13

Ethics in Engineering Writing

CH 11

14

You might also like