Writing technical specifications

Book now Summary This course emphasises the need for a clear definition of specification requirements combined with the ability to communicate them effectively to third parties.

Writing technical specifications

Label diagrams and graphs as follows; Figure 1. In this example, the second diagram in section 1 would be referred to by " Any phrases, sentences or paragraphs which are copied unaltered must be enclosed in quotation marks and referenced by a number. Material which is not reproduced unaltered should not be in quotation marks but must still be referenced.

It is not sufficient to list the sources of information at the end of the report; you must indicate the sources of information individually within the report using the reference numbering system. Information that is not referenced is assumed to be either common knowledge or your own work or ideas; if it is not, then it is assumed to be plagiarised i.

This is a serious offence. If the person copied from is a fellow student, then this offence is known as collusion and is equally serious. Examination boards can, and do, impose penalties for these offences ranging from loss of marks to disqualification from the award of a degree This warning applies equally to information obtained from the Internet.

It is very easy for markers to identify words and images that have been copied directly from web sites. If you do this without acknowledging the source of your information and putting the words in quotation marks then your report will be sent to the Investigating Officer and you may be called before a disciplinary panel.

Now you must add the page numbers, contents and title pages and write the summary. It must be intelligible without the rest of the report. Many people may read, and refer to, a report summary but only a few may read the full report, as often happens in a professional organisation.

Purpose - a short version of the report and a guide to the report. Length - short, typically not more than words Content - provide information, not just a description of the report. You should acquire the habit of never sending or submitting any piece of written work, from email to course work, without at least one and preferably several processes of proofreading.

In addition, it is not possible for you, as the author of a long piece of writing, to proofread accurately yourself; you are too familiar with what you have written and will not spot all the mistakes. When you have finished your report, and before you staple it, you must check it very carefully yourself.

You should then give it to someone else, e.

Writing technical specifications

You should record the name of this person in your acknowledgements. This includes words, word order, style and layout. Word processing and desktop publishing packages never make up for poor or inaccurate content They allow for the incremental production of a long document in portions which are stored and combined later They can waste a lot of time by slowing down writing and distracting the writer with the mechanics of text and graphics manipulation.

They can be used to make a document look stylish and professional. Excessive use of 'cut and paste' leads to tedious repetition and sloppy writing.

They make the process of proofreading and revision extremely straightforward If the first draft is word processed, it can look so stylish that the writer is fooled into thinking that it does not need proofreading and revision!Wise Words About Writing Technical Requirements Documents Try Smartsheet for Free Preparing technical requirement documents (also known as product requirement documents) is a typical part of any project to create or revise a software system, or other types of tangible products.

May 03,  · Technical specifications are now an after thought which are supposed to be written after the work is done. And I for one forgot my old practices and followed the newer way and wrote up what I did..

rather than what was supposed to be done.

Writing technical specifications

The related video lesson, Writing Technical Specifications, will enhance your knowledge of the content covered on this quiz and worksheet. Covered on the lesson will be: The necessity for. A Business Requirements Document (BRD) is a formal contract between the organization and the customer for a product.

A BRD is used through the entire cycle of the project to ensure that the product meets the detailed specifications and that the project gains value and achieves the desired results. Writing better technical specifications GEOFF COVEY AND GERKE FABER Directors, Covey Consulting Pty Ltd, PO Box 81 Somerset, Tas , Australia.

Jul 01,  · An online training module for agency procurement officers working with the West Virginia Purchasing Division.

Online Technical Writing: Types of Technical Documents