Technical Writing 2z1z2z

Cruz, Michelle A. 1. Differences between Technical Writing and Creative Writing. Key Differences between Creative Writing and Technical Writing In creative writing the most of the part is self-created, although the idea might be inspired but in technical writing the facts are to be obliged and the note is delivered from leading on what previously other greats have concluded. Most commonly, the creative writing is for general audience or for masses but technical writing is for specific audience. The creative writing entertains people as it has poetry or some illustrations or another idea, whereas the technical writing causes boredom as it follows the strong pattern based on facts and is just to transfer the information to the audience. In technical writing the specialized vocabulary, such like scientific and other are used while in creative writing, one can go with slang or evocative phrases or even something which can be perceived well by the audience. Humor, satire might be the useful essences in creative writing but such thoughts or ideas have no link with the technical writing. Novel writing, poetry writing, satirical note are some of the types of creative writing, whereas report analysis, proving formulas are types of technical writing. Source: Difference between Technical Writing and Creative Writing By DifferenceBtw.com, UK based information portal March 2016 http://www.differencebtw.com/difference-between-technical-writingand-creative-writing/ TECHNICAL WRITING AND IMAGINATIVE WRITING Imaginative writing also holds principles of unity, coherence and standard usage. Imaginative writers also let their ideas emerge and develop over time. However, such writing is less academic and more artistic and creative than technical and academic writing.

Imaginative writing can be ambiguous, meaning different things to different people. Imaginative writing also requires the reader to draw inferences, to make judgments that the writer does not state. Technical writing should be unambiguous and direct. A work of literature may be rich because it means different things to different readers. You expect to make inferences about poetry. You do not expect to make inferences about technical writing. Source: Technical Writing for Success (2nd Edition) by Darlene SmithWorthington and Sue Jefferson 2. The ABC’s of Technical Writing PROPERTIES OF TECHNICAL WRITING Accuracy A technical paper should be free from errors. A misplaced element or misstated fact could make months, even years of labor worthless. Accuracy of statement depends not only on individual words but on the way sentences are put together, the way the paragraphs are developed, and the way the report as a whole is balance. In conclusion, a technical writer should guard himself against being misunderstood. Brevity A technical paper should be short or brief and makes use of concise expressions. A technical writer should begin with his main point and then show why it is sound. Emphasize the highlights of your work, cut out

irrelevant comments, immaterial excursions

and

meaningless statements. Confidence A report writer should develop on his paper the sense of reliability and trust. He should be sure enough to know more about the subject than anyone else at that time. If he convinced that he is saying

is right, he should say it. If not, he should go back to see where the problem lies and how he can correct it.

Dignity Dignity refers to the quality or state of being worthy, honored, or esteemed. Grammatical constructions in a technical paper should be complete.

This

can

expression and

with

also be

achieved

with

straightforward

summarized, simplified and well organized

information. Emphasis A report writer should know how to stress major points. As a matter of course, the writer must indicate the most important ones and never expect the reader to find it out for himself. He should tell the reader what is important and lead him from point to point by using a straightforward style plenty of guideposts and transitional aids. Facility Facility is making the report easy to read and understand. For facility, report writing should observe pacing, sequence, arrangement, and continuity. PACING – is presenting technical and unfamiliar information in small segments, explained, defined or illustrated before more of such information is presented. SEQUENCE – is leading the reader from familiar to unfamiliar, from the simple to complex, from the whole to the parts. ARRANGEMENT – is emphasizing and balancing important parts to show their proper relationship and importance. CONTINUITY – is showing that the thought of one part to another should be clearly established, illustrated or stated. Grammatical Correctness

It is the rule of the thumb that whatever kind of writing a person does, the application of grammatical rules is a must. Honesty Honesty in writing is chiefly acknowledging the use of other people’s information or work either in footnotes or in text. This can also be shown by telling the readers, one’s successes and failures.

Illustration Illustration material referred to as graphics or visuals which includes charts, diagrams, tables, photos and other which is used to elucidate, clarify and the writer’s views, precept, idea, or the text given. Judgment This can also be referred to as qualifying or weighing the materials that he had gathered. These can be done by considering these criteria: (1) most ample; (2) most relevant or pertinent; (3) most simple in explaining the facts with least additional evidence; (4) most harmonious with the rest of the data and information. Knowledge Knowledge which is more than a collection of data, involves interpretation and the formulation of conclusions. Logic Logic is thinking straight. It is the process of showing the relations among groups of things and classes of groups. Fundamentally, it is the way of doing classification – putting things in their proper slots. By thinking logically, one can avoid the following trouble spots: 1. Statements must not contradict each other. 2. Words must be used in a consistent sense.

3. Statements must move in one direction, whether space, time, or relation. 4. Statements must make sense. 5. Judgments must not be based on too few data. 6. Cause and effects should be clearly distinguished from simple sequence. 7. Conclusions should not be inferred if they have no connection with the data. 8. An authority should not be accepted if he is biased or he is not an expert in that particular field. Mechanical Neatness Mechanical Neatness connotes the general appearance of the report. It involves putting the report in perfect shape –neatly typed and well margined. A presentable and neat report reflects that the writer gave enough time and effort to give the very best. Normal Procedure Normal procedure is following or conformity to the acceptable arrangement of the different parts of a report. Report readers are used into finding information presented in standard fashion. If someone departs from this, readers tend to be confused. Objectivity Objectivity is the writer’s assuming a detached, impartial point of view. He writes not impress but to express his ideas, beliefs or perceptions on the topic he is working out. He should treat his subject matter the way he sees or observes it. Planning This gives purpose and direction to what he has to write. It involves thinking ahead of what one has to do. When to do it, how to do it and who is to do it. Qualification

Qualification is explaining the circumstances surrounding the work because they might have affected the results to be reported. It also includes the evaluation of ideas, facts, or statements to be included in the development of the report. Revision Revision is more than checking the spelling, punctuation marks, spacing and margin. An effective report is one that is published and refined to its perfection. The secret of good writing is rewriting. Straight Sentences It is a good practice that the sentences to be employed must be limited to only one idea or two closely related ideas. Thoroughness Thoroughness is treating the subject fully for the report to have a lasting value. He has to make sure that he has said enough to satisfy the reader’s needs and achieve his objectives. Unity Unity implies that all details and facts in the report are clearly relevant to the main point under discussion. The main objective of a unified report is to let the readers feel that they have read everything essential to the subject undertaken. Viewpoint The viewpoint is established with the first sentence and should be maintained consistently throughout the report. Word Choice Your report may be read by non-specialist as well as specialists in your field but it is safe to assume that this non-specialist is at least a semispecialist or he would not be reading your report. He will have enough sense to grasp the meaning of specialized words so there is no reason to avoid technical words in a technical report. There is good

reason, however, to avoid pompous, ornate words and especially vague words. You-Point A report is aimed at an audience. Thus your information can be presented in segments appropriate to your readers’ knowledge and needs. Zest Write only when you have something worth saying, and then write as though you were performing service that only you can perform. Moreover, write as though you enjoyed it. Source: Elements of Technical Report Writing by Paul M. Zall (1980) Writing a technical report is often a real challenge for many technical professionals. The research, investigation or designs are why you’re doing what you love to do… but then you have to write a report. And that has the potential to be the weak link. But there are some features of technical writing that are essential, whatever your field or organization. I like to them as the ABCS of Technical Writing: accuracy, brevity, clarity, and simplicity. 1) Accuracy: accurate reporting of your findings; accurate presentation of the facts; accurate representation of your findings, in accordance with the methods you’ve used. Make sure you clearly indicate where you’ve expressed an opinion, rather than a certain outcome of your investigation. As far as possible, give specific information rather than generalizations. 2) Brevity: Try to keep the document as short as possible – time-poor readers will appreciate that. Consider placing background and ing information into an appendix, footnote or endnote

reference. As much as possible, keep sentences short (15 to 20 words works well for most readers), with only one idea expressed in each sentence. 3) Clarity: Use familiar vocabulary and constructions (make sure you’ve thought about who will read your report and be prepared to explain potentially unfamiliar words, perhaps as a glossary, footnote or endnote). Be consistent with your terminology, abbreviations and presentation of figures, tables, illustrations, etc. Consider using tables, figures, graphs, illustrations to demonstrate your point… as ‘they’ say, a picture saves a thousand words. that jargon (specialized used in your field) excludes those who are unfamiliar with those words. Use precise words: your readers don’t appreciate having to decide if a word has a slightly different meaning in different contexts. A useful technique is to use bullet or numbered points to express complex ideas (if your discipline or organization allows). 4) Simplicity: This is about expressing your thoughts with simplicity, not simplifying your work. your readers: you want to show them the value of your work, not what a good writer you are. The content is more important than extravagant writing. Verbosity hinders your readers’ understanding. Make sure you’ve thought about the logical progression of your report. Plan the structure of your document so that you lead your readers to the conclusion you’ve reached. The simplicity inherent in the use of plain English (active voice, reasonable sentence length, wise use of specialized , no verbosity) will serve you well. Source: The ABCs of Technical Writing – 4 Features Technical Writers Need to Know By Desolie Page

March 20, 2010 http://www.technicalcommunicationcenter.com/2010/03/20/the-abcsof-technical-writing-4-features-technical-writers-need-to-know/