Добавил:
Опубликованный материал нарушает ваши авторские права? Сообщите нам.
Вуз: Предмет: Файл:
(EOD).Reference information.pdf
Скачиваний:
23
Добавлен:
23.08.2013
Размер:
1.49 Mб
Скачать

page 98

3.4.5 References

References help provide direction to the sources of information when the information may be questioned, or the reader may want to get additional detail.

Reference formats vary between publication sources. But, the best rule is be consistent.

One popular method for references is to number them. The numbers are used in the body of the paper (eg, [14]), and the references are listed numerically at the end.

Another method is to list the author name and year (eg, [Yackish, 1997]) and then list the references at the end of the report.

Footnotes are not commonly used in engineering works.

3.4.6 Acknowledgments

When others have contributed to the work but are not listed as authors we may choose to recognize them.

Acknowledgments are brief statements that indicate who has contributed to a work.

3.4.7 Appendices

When we have information that is needed to support a report, but is too bulky to include, one option is to add an appendix.

Examples of appendices include,

-reviews of basic theory

-sample calculations

-long tables of materials data

-program listings

-long test results

3.5 GENERAL FORMATTING

• Some general formatting items are,

page 99

- number all pages sequentially,

roman numerals starting from ‘i)’ on the first page arabic numerals starting from ‘1’ on the

- or, number pages by section. This is very useful for multi part manuals for example ‘4-7’ would be the 7th page in the 4th section

-if pages are blank label them ‘this page left blank’

-number sections sequentially with roman or Arabic numerals

For numbers,

-use engineering notation (move exponents 3 places) so that units are always micro, milli, kilo, mega, giga, etc.

-use significant figures to round the numbers

-units are required always

General English usage,

-check spelling - note that you must read to double guess the smell checker.

-check grammar

-avoid informal phrases (e.g. “show me the money”)

-define acronyms and jargon the first time you use them (e.g., IBM means “Ion Beam Manufacturing”)

General style rules,

-keep it simple (especially the introduction) - most authors trying to be eloquent end up sounding long winded and pretentious. For example, “Electronic computer based digital readings can provided a highly accurate data source to improve the quality of the ascertained data.” could be replaced with “Computer based data collection is more accurate.”

-get to the point and be concise. For example, “Readings of the pressure, as the probe was ascending up the chimney towards the top, were taken.” is better put “Pressure probe readings were taken as the probe was inserted”.

-it is fine to say ‘I’ or ‘we’, but don’t get carried away.

-don’t be afraid to reuse terms, phases or words if it is an exact description. For example, we could increase confusion by also describing translation as motion, movement, sliding, displacing, etc.

General engineering rules are,

-all statements should be justified, avoid personal opinions or ‘gut feels’

-use exact engineering terms when needed, don’t try to get creative.

Соседние файлы в предмете Электротехника