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

Tecnical Report Writing

tecnical report writing
tecnical report writing
tecnical report writing

Technical Report Writing Example

technical report writing example"technical report writing example"

Stylewriter V4.0 Review – Plain English for Legal Document Writing

How would you like it if every letter and report from your professional adviser was quick and easy to read? If their documents were quick to review, with the main points emerging clearly? If you could copy their advice to your business colleagues without first having to translate it into business English?

Some law firms know their clients would love this, but are not quite ready to deliver it. Their lawyers learned their style from judgments, statutes, textbooks, teachers and colleagues, all pretty much using the same style clients have been complaining about for hundreds of years. (IT professionals sometimes meet similar criticism from lawyers.)

That style is not easy to read or quick to review. See how long it takes you to find the error in this 56-word sentence.

‘Without prejudice to any other right or remedy we may have, we reserve the right to set off any amount owing at any time by you to us, whether under this Agreement or any other agreement which may exist from time to time between us, against any amount payable by you to us under this Agreement.'

Perhaps your clients don't mind legalese in their agreements. But do they want it in your advice? Or in your legal updates and pitch documents? One way to eliminate hard-to-read documents is to use plain English style checking software, such as StyleWriter.

What does StyleWriter do?

StyleWriter is a Word add-on. You click on a button and in seconds it has checked the whole document for the three main obstacles to understanding: long sentences, passive verbs, and hard words. It gives the document a score for the first two, and an overall score for clarity. And it suggests improvements.

It works like a spellchecker, flagging word patterns it has been taught to recognise as potential problems. Where possible, it offers alternatives for the writer to accept or reject (or ignore) with a click of the mouse. Or it may suggest ways to edit out the problem. As you edit, StyleWriter updates its scores. It gathers statistics to help organisations audit their documents for clarity. What you can measure, you can manage.

In three years of working with StyleWriter, I have found its advice sensible and user-friendly. If a document scores well on StyleWriter Software, it is not hard to read.

What doesn't it do?

StyleWriter is no substitute for expert editing. It can't solve problems, only flag them up. It can't tell you where to add headings, or how to chop up a long sentence or why lawyers keep saying ‘from time to time'. If you don't know these things, you need training to go with it. But it can tell you whether your own solution to these problems is easy or hard to read.

StyleWriter can only check language, not other important aids to ease of reading such as good layout, useful headings or a logical treatment of the subject. And it is no judge of context, so the author must always decide whether to accept its advice.

Other Writing Software like whitesmoke, ginger software are only check spell & grammar too, but they are focus on text enrichment & grammar checking. More about these 3 top rated writing software, see whitesmoke, stylewriter, ginger software comparison.

Example

Here's what you get when you run StyleWriter on the clause just quoted.

The ‘Style index' is the score for clarity, taking into account the average sentence length, percentage of passive verbs, and a lexicon of tens of thousands of words and phrases it has been taught may unnecessarily hamper the reader's understanding.

Here's another version of the clause, ten words shorter and in three short sentences, making it quicker to review. See how long it takes you to find if the mistake is still there.

‘Set-off:We may set off anything you owe us under any agreement against anything we owe you under this Agreement. This does not affect any other right or remedy we may have. It is not limited to agreements already made or sums already due.'

Its scores reflect the improvement.

Style Index 45 Average for General Writing
Average Sentence Length 15 Excellent
Passive Index 33 Good

Does it work on legal documents?

StyleWriter is designed for business, government and academic use. So it doesn't pick up problems unique to the legal profession, like the abuse of 'shall' and 'such' and it questions legal terms that lawyers use correctly, such as ‘novation' and ‘fiduciary'. You can tailor StyleWriter's advice for legal documents; I've done it myself twice, although it's not a job for the novice. But if your aim is to write business English, the original lexicon will give useful results even on legal documents.

What about pitches and legal updates?

Contracts and legal advice don't need to grab the reader's attention; any reader usually has a strong motive to find out what they say. If the writer has set no obstacles in their way, you can honestly call the clarity ‘Excellent'.

But the Bog index draws on an even wider lexicon of 200,000 words, plus acronyms and technical terms, to measure whether the text is gripping or boring. If boring, StyleWriter can offer only general advice – to write in personal terms (you and we), use contractions (can't and won't), include names (Daphne not The Author) and use lively verbs. You can display graphically the most and least boring words and sentences in your work, to help you edit. The Bog index for both the original and rewritten clauses is better than the Style index, because it gives them credit for using you and we.

The real value of the Bog index is for pitch and marketing text or anything the client or prospective client has not paid for and might decide not to bother with. Take this text from a firm's web site, which has an Excellent style score but is still boring, with an Average Bog index (55).

A negligence claim against a professional services firm can be expensive, time-consuming and, for the individuals concerned, traumatic. Our lawyers have been helping these firms for more than 10 years. Our professional liability team consists of experienced lawyers from our commercial litigation, construction and finance groups, based in our offices throughout Europe and the Far East.

Compare this opening paragraph from a legal update, with a Good Bog index (27).

Say you received your payslip one day and noticed that out of the blue your salary had been doubled. Tempting as it would be to keep schtum, surely most of us would put our hands up and query the figure?

Doesn't Word have a style checker?

Word 2003 and 2007 both include a Grammar check tool. It works like a spell checker, with an option to display statistics. Word's readability statistics for the original set-off clause look like this:

This tells you the percentage of passive verbs and the average sentence length. And it says you'd need 25 years of education to understand this clause at first sight. But it doesn't identify this clause as a long sentence, because it only does that for sentences over 60 words. In fact, Word finds no fault with the clause at all.

Its grammar checker merely tells you ‘That style is not easy to read or quick to review'. If you can add a Style check (2007 only) it actually strips out plain English, suggesting you replace But with Nevertheless and Or with On the other hand. Lawyers don't need this sort of advice.

Other products exist to help edit your writing, such as MyWriter Tools. This is cheaper but you may not find it as useful.

Are there any technical limitations?

You need Word to get the full benefit of StyleWriter. If Word is your email editor, you can also use StyleWriter to edit Outlook files. And you can edit clipboard text copied from other programs, but you need to copy it back again when done.

You can install StyleWriter on a network, which may involve some work to get it working smoothly with a document management system. You'll need to decide whether to allow users to add or delete words and phrases, or to do it only centrally. You could also decide to add your own house style to StyleWriter's advice.

StyleWriter v4 costs £110 plus VAT or $160 for a single user.

About the Author

Joseph Zheng is a blogger from BASINGSTOKE, UK. He writes about writing software reviews and copywriting tips. For more infomation about plain english writing, visit blog stylewriter software

.

27 Economics-KINGSTON UNI MASTER.mov


technical report writing example
technical report writing example