Posts Tagged ‘reader’

Basic Elements of Technical Writing

Technical writing is a specialised form of writing.

Its goal is to help readers use a technology or to understand a process, product or concept. Often these processes, products or concepts are complex, but need to be expressed in a much simpler, reader-friendly form.

So within the technical writing genre, you will find: technical reports, installation and maintenance manuals, proposals, white papers, on-line help, process standards, work instructions and procedures.

While each discipline has its specific requirements, some basic elements are common. But before looking at those, the most important thing a technical writer must consider is the audience.

Audience:

How familiar are readers with the subject and with the specialised terms and abbreviations you need to use?
What is the best way to explain those terms or shortened forms – footnotes, endnotes, glossary, table of abbreviations, appendix, links?
Do you need to accommodate secondary readers (e.g. the manager or financier who will make the decision about the proposal), and how will you do that?
Now for those all-important elements:

Clarity – The logical flow of the document will help readers understand the content. It can be useful to ask someone who is not familiar with the topic to review your writing before you finalise it. Using headings, illustrations, graphs or tables can be useful – your aim is to make it as easy as possible for your readers to understand what you’ve written. Consider how the way the text sits on the page or screen – another clue to maximising clarity for your readers.
Accuracy – The information and the interpretation of data that you present must be accurate. If it’s not, your readers will question the credibility of the content. Be careful to clearly differentiate between fact and opinion, and to accurately cite references to other works.
Brevity – Strive to find the balance between the amount of information presented and the time needed to read the document. Remember that you can use an appendix or link to provide supplementary or background information. Consider using an illustration, table or graph rather than words to explain a concept – but remember, if you use a ‘visual’, don’t give a long written explanation.
Sentence length – Generally, complex or unfamiliar concepts are best presented in shorter sentences. This will give readers time to digest small pieces of information before moving on to the next. While this can be difficult to achieve, try to aim for approximately 25 words per sentence. If you find you’ve written a series of long sentences, look for ‘and’, ‘but’, ‘however’ and similar words where you can break the sentence.
Paragraphs – The age-old rule about one topic per paragraph is a useful guide. That doesn’t mean that you can have only one paragraph for each topic, but it does mean that having only one topic in each paragraph makes for clear, logical writing.
Reader-centricity – You are writing for your readers. Make it as easy as possible for them to understand your work.
Keep these basic elements and other principles in mind as you undertake your technical writing tasks.

Practical Guidelines to Writing Successful College Essays and Term Papers

Research is the backbone from a writing along with the sources that you apply for your research are essential. Primary sources include by way of example, newspaper cuttings, interviews and any source that quotes straight from for instance historic witness accounts. These are generally often considered more valuable than secondary sources. Secondary sources, are as their name suggests, second-hand accounts of events. For instance, a history book compiled by an author using primary sources to interpret an historical event.


Your use of varied reasons for research will enable you to determine the weaknesses and strengths of one’s argument. Your paper, in place must be an answer to a debate proposal – for instance, “this house believes: that dieting will not work”. You ought to inside your research often be conscious of what arguments the opposition are likely to submit, so that you are answering and adjusting these arguments in your writing. By way of example, the a reaction to the proposal might be, “Weight Watchers is a successful organisation because its members shed weight.” The weakness in the argument may be, “but, how many members successfully maintain your pounds off?” just like a crowd following a debate will have doubts about your argument, so too will the various readers, therefore it is wise to formulate a response to those doubts and expose them as incorrect. This can be achieved by using quotations from expert sources as an example. By using a number of sources will assure you present a structured argument and you obtain reliable information upon which to base your arguments.


Before you even set out to write your paper you ought to plan what points you need to make. Planning your paper is vital. It’s a true saying that- “if you fail to plan – you intend to fail”. Once you have a solid idea of the direction you would like to steer the ship, then you’re able to enjoy experiencing and enjoying the journey! Your plan should specify distinct points you want to produce in a very rational manner. These points should make up the basic structure as paragraphs for your paper. Introducing each concept for the reader, developing it and destroying any possible doubts about your arguments help keep the reader interested and help them to to talk to your perspective clearly.


Every article must lead the various readers gently into the area of interest by using an introduction and college papers aren’t any different. You wouldn’t expect a friend to see the punch line of your joke without build-up otherwise the joke would fall flat. Equally, folks who wants lead your reader in by setting the scene through out your discussion using an introduction, your college paper may suffer the identical fate and the reader might not want to continue reading. The introduction should make an effort to summarise and engage the various readers.


An introduction is essential when writing a university paper for many reasons. Firstly, a reliable breakdown of an item dispenses while using assumption that this audience mindful of the niche matter. It also gives them a flavour of what you should expect in the development and helps people to attune his thoughts for your kind of writing. Most crucial coming from all, an excellent introduction should summarise the piece and provide some idea of what the conclusion will be. Suppose the introduction as a synopsis of the entire work, however long that work well maybe. A successful introduction can tell you for the reader the paper is approximately and prepare them for the development of that idea or argument.


Think the development section -the middle- of your college paper, as a way of convincing the reader of the argument. Decide what points you wish to make. This is where your pursuit also comes in. Your quest will strengthen and educate your own views and opinions. Your career now’s to make use of the investigation to backup your arguments effectively.


The conclusion in your paper should remind the various readers the reasons you hold particular opinions and the reasons for them and provide them an extra opportunity to agree or disagree together with you depending on the arguments and facts that you just present.


To conclude:


- Investigate the topic

- Be critical in your research – Read having a question planned, always be critical from the secondary source material that you just read. If it’s not direct “from the horses mouth”, then question the writer’s motives for holding their opinion, is it biased? As an example, is a dieting magazine a proponent of diets, because which is their raison d’etre?

- Brainstorm – Brainstorming with friends helps you to clarify your opinions, if you’re able to argue a subject matter aloud, you are more prone to be capable of argue it on paper.

- Plan your hard work in logical points

- Write the key points of one’s conclusion when you develop the paper, doing this if you have a map of what your location is looking to get to, you will be able drive an automobile there quicker.

- Utilize points from your plan as paragraphs in your paper for each individual idea.

- Develop these points by explaining their rationale on the reader, justify them making use of your research and eliminate any opposing arguments by backing up yours using the facts not merely opinions.

- In case you are writing within time constraints of your examination and fail to complete the paper, you will definately get marks for planning your paper, for the reason that examiner should be able to identify that you already know the niche.

- Readily appropriate style for your audience – meaning adjusting your language and tone, sentence length and vocabulary to suit the audience.

- Always introduce the topic- Summarise what you’re likely to say to them: –

- Tend not to make assumptions – Usually do not assume the reader is knowledgeable about the subject matter

- Be aware of your audience:-be conscious of whom you are trying to convince and tailor your argument fot it audience. This should actually be reflected inside your language and tone and ultimately your style of writing.

- Research before you buy – you can’t be prepared to competently argue your point, should you not have strong facts and opinion that to back it up.

- Develop your argument- use the research sources and quotations you’ve gathered to formulate and substantiate your arguments.

- Be familiar with your personal prejudices and make a conscious effort to become objective.

- Conclude the piece by summarising your original thesis, or idea.

- Check the writing for grammatical errors and spelling mistakes as this can let your documenting and irritate the reader.

- Read the paper thoroughly, aloud if possible making amendments, try not to be afraid to shorten the paper detail means that your paper grows more succinct.

- Remember – the best writing talks to people and wins people over almost without one realising it!