Basic Principles & Characteristics of Technical Writing & Styles of Technical Writing Flashcards
3 Stages of Writing Process
Pre-writing
Writing
Rewriting
where the writer writes and composes information pertaining to the purpose of his paper, choice of topic, and gathers information
Pre-writing
the part where the writer writes his first draft and works out on the important details of his work
Writing
also known as the revision stage where the writer revises his work to ensure that the content of his paper is relevant, the ideas are well organized, and grammar and mechanics are clearly observed
Rewriting
Basic Principles of Technical Writing
● Know you readers
● Use simple, concrete & familiar language
● Introduce your report in a well-organized manner
● Have a clear and exact purpose
● Use correct format
● Adopt ethical standards
Qualities of a Technical Writeup
● Accessibility
● Accuracy
● Clarity
● Correctness
● Objectivity
● Thoroughness
○ When you are writing a report or any type of correspondence, always have in mind that there is a specific reader, real or imaginary
○ Consider that they are intelligent but need to be informed
Know your readers
○ Before you start to write, remember to decide on what the exact purpose of your report or write-up is
○ Make sure that every detail — words, sentences, paragraphs make a clear part of that purpose
Have a clear and exact purpose
○ Used so that report is easily understood
○ It will clearly define and visualize your work
○ The use of these will avoid confusion form your readers
Use simple, concrete & familiar language
○ Assist your reader to a complete understanding of your idea through clear description, definition, and explanation
○ The writer must check every part of his report to see whether he has followed the basic principles
Introduce your report in a well-organized manner
○ Using this will attract the attention of the readers
○ Aside from the aesthetic sense, the layout must follow the standard forms of writing
Use correct format
○ As a writer, you only present facts, figures, and statistics that focus only on your subject matter in an impersonal manner
◆ A good technical writer emphasizes only facts and data
◆ His work is free from biases and unfairness
Adopt ethical standards
means capable of being reached, used or seen, understood or appreciated, and easy to deal with
Accessibility
Accessibility’s aim is for
ease of navigation and availability
means that it is definite and precise
Accuracy
Accuracy means that it is?
definite & precise
○ It is essential that you as the writer, know and understand the background of your intended reader so that, when he reads your document, it can be easily understood without any doubt or confusion
○ Your document becomes meaningless if the intended reader does not understand your message
Clarity
○ When writing, avoid unnecessary words that will put your reader in a dilemma
○ Your document must be clear so that the text becomes easy to understand
Clarity
○ Effective technical communications (in writing or verbally) cannot be achieved unless you successfully comply with appropriate grammatical and technical rules
○ Also, you must always ensure that the information (data) you present is accurate and up-to-date
Correctness
Effective technical communications (in writing or verbally) cannot be achieved unless you successfully comply with appropriate _____
grammatical & technical rules
You must always ensure that the _____ you present is _____ and _____
information (data)
accurate
up-to-date
Aspects of technical communications that should be adiusted according to your audience level
◆ the amount of detail
◆ organizational pattern
◆ level of technicality
◆ type of vocabulary
◆ mechanics
◆ appearance