Technical Report Writing Example

technical report writing example_2"technical report writing example"

Little Things That Matters in a Project Report

Students appear to overlook some of the little things that matters when writing a project. When preparing a technical writing, especially project report, the following little things should be taken note of. They are

1. Precision and Vigour


2. Spelling and Grammar


3. Typography


4. Illustrations

 1.  Precision and Vigour

When writing a project report, you must first try to be precise. When you write, it is not sufficient to think that you know what you mean or what you intend to mean. The meaning of what you are writing must be clear and be free from misinterpretation. Take care to choose the right words for your write-up. For example, the phrase "Mr. John's son and his wife"may create misinterpretation as whether ‘wife' in the phrase is referring to the wife of Mr. John or the wife of Mr. John's son; whereas in your mind you may be referring (or intending to refer) to the wife of Mr. John and not the wife of Mr. John's son, while the phrase may be interpreted differently by readers.

 Precision in project writing is mainly a matter of taking sufficient care. Good project writing should not only be precise, but it should also be vigorous. Here are some hints which might help you to write precisely and vigorously.

 Use short sentences instead of long sentences.

• Use short words instead of long words, provided that the short words have the meaning you need. In fact, shortness is a great virtue in technical writing, especially in project writing.


• Minimize the use of Latin phrases (but the occasional Latin quotation might lend a spurious air of erudition to your writing!)

 2.  Spelling and grammar

When writing your project report, you must take exceptional care to spell correctly. Poor spelling is a distraction to the proficient reader and it impedes understanding in your project report. However, nowadays, there is very little excuse for spelling errors as there are many excellent spell-checker computer programs which make a good job of finding the errors for you, and excellent (paper) dictionaries which will tell you what the correct spelling is. So, you have to be very careful with words whose common misspelling is a correct spelling of a different word, in particular the following pairs: lead/led; loose/lose; affect/effect; etc.

 Note:   If you have a medical condition which makes it difficult for you to spell correctly, make sure that your project supervisor knows about it, so that it can be taken into account by the examiners.

 Even if you yourself do not place a strong emphasis on good spelling and good grammar, most of your examiners do, some fanatically. Most examiners will be irritated by poor spelling and poor grammar. It is always worth doing whatever you can to put your examiner in a good mood. So, write well and spell well to add more credits and understanding to your project report; which leads to better grade.

  3.  Typography

Typography means the set-out rules/format that specify the formal requirements such as the number of pages, font size, width of margins, and so on, which you should use to prepare your project reports. Actually, you will not be penalized severely if you violate typographical conventions, but good typography creates a latent impression similar to that of good proportion in a painting, and is desirable for that reason. Since it is a matter of simply learning and following the rules, you should try to do so in your project report. For example, you should learn at least enough to know the difference between the hyphen, minus, en-dash and em-dash, and when to use each of them in your project report.

 4.  Illustrations

Your report should generally contain illustrations (figures or diagrams), but they must be relevant to your research you are carrying out in your project. Ask yourself if the illustrations help the reader to understand the text. If the text is readily comprehensible without the illustrations, delete the illustrations. If not, use illustrations to support and clarify your points in the report; and where applicable, include illustrations such as figures and tables close to the text which refers to them, rather than lumping all together in an appendix.

You may wish to get more information of project writing at www.academictreasure.com.

 

About the Author

Dr. Ben Mbam has helped thousands of people achieve their academic goals in colleges and universities. He is a seasoned author on many academic matters. He publishes great articles and provides study guides for students at www.academictreasure.com. He is also a powerful adviser on Love, Dating and Relationship.

Requesting a Database Adjustment (Closed Caption)


technical report writing example
technical report writing example
technical report writing example