Good Writing
Practices
1.-Correct grammar and neat
presentation
Written
reports should be proof-read to avoid trivial grammar errors and spelling. New
sections are clearly marked with extra line spacing,
and use bold or underline font for section titles.
2.-Logical arguments and
structure
Avoid
incorrect implications or conclusions of the type: if an egg is dropped on a
white shirt leading to a yellowish spot, therefore, I can conclude that a
yellowish spot on a white background should come from an egg. That is NOT
necessarily true: a dropped egg leads to a yellowish spot, but a yellowish spot
could come from spilled paint, yellow markers, etc. However if there is a
yellowish spot and it also smells egg, then most probably it came from an egg.
This is correct! Make sure your arguments or conclusions are logical and sound.
When a
statement or conclusion is made, it needs to be supported first by specific and
relevant evidences. Avoid generic conclusions without detailed evidences and
supports, such as “I learned a lot”, or “I learned electrical engineers made a
lot of money, biomedical engineers create medical devices, I learned a lot”.
3.-Accurate report of the team
project and completeness, and no plagiarism
By
signing a written documentation you certify that the presented information
truly reflects work performed and data obtained. Modifying data or omitting
important information are violations of the professional code of ethics. Also,
work from other authors, if used, needs to be adequately acknowledged in the
form of references. Standard ways of citing a reference is:
If it
is from the internet: the complete URL address and author’s or organization’s
name if known: e.g. http://www.faculty.umb.edu/tomas_materdey/e103
If it
is from a book: author’s name(s), book title, edition number if any, year of
publication, publisher, in that order
If it
is from an journal article: author’s name(s), article title, complete journal name( can use standard abbreviations), volume number, issue
number (if any), pages number, date of publication, in that order.
These
references could be inserted within the text or listed together at the end of
the document ordered by a reference numbers (the reference numbers will then be
inserted in the text when needed).
Following
good writing practices will add credibility, seriousness, and professionalism
to your good work, make it stand out, and earn the reader’s respect and
consideration.