A REPORT REQUIREMENT IN TECHNICAL WRITING

Submitted to: PROF. ESTER A. TABINAS Arellano University Pasay Campus

Submitted by: KITANE, MARLENE R. January 30, 2012

A. 1. What is the rationale of knowing technical writing as a discipline? 2. Define technical writing by your own words. The subject being written about may be abstract or tangible. And it is also a term that represents an increasingly broad set of activities that are designed to communicate understandable information that can help people be productive. A method of researching and creating information about technical processes or products 3. What are the basic characteristics of technical writing? Technical writing is an important part of everyone's career. Writing well is difficult and time consuming and writing in a technical way about technical subjects even makes it more difficult. People write to propose projects, to document their own actions, to help other understand the research, to analyze and solve problems, to describe procedures and objects. If done well, technical writing is an exciting, fulfilling experience but if done poorly, it is frustrating, even harmful to career development. Technicality in writing is based upon the following points There are six basic properties of Technical writing Clarity Accuracy Comprehensiveness Accessibility Conciseness Correctness 1. Clarity Technical document must convey a single meaning that the reader can understand. Unclear Technical writing is expensive. They vital communication link among the various employees is usually the report, if this link is weak, the entire project may be jeopardized. Unclear technical writing can be dangerous e.g. unclear instruction on how to operate machinery. 2. Accuracy Unclear writing can cause many problems and even inaccuracy in the report. If you mean to write 40,000 dont write 400,000. Slightest error can confuse or even

annoy the reader of the report. If the reader suspects that you are slanting information they have the right to doubt the entire document. 3. Comprehensiveness: When writing technically, all the information should be provided, its background must be described and clear description of any process, or method of carrying out a specific work, should also be given. It also includes results, conclusions and recommendations. 4. Accessibility: It means the ease with which the readers can locate the information they seek. To increase Accessibility, include headings and lists in the report. A table of contents, list of illustrations glossary and index are preferred. 5. Conciseness: Technical writing is meant to be useful. The longer a document is, the more difficult it gets to use it. Even it takes more of the user's time. Conciseness works against clarity and comprehensiveness. Solution to this conflict is to create a balance between the requirements of clarity, conciseness and comprehensiveness. In short, in T.W every aspect of the subject is discussed in optimized detail. Document must be long enough to be clear. It must give the audience purpose and object but no extra details. Technical writing can be shortened 10-20% by eliminating unnecessary phrases and choosing short words and sentences. 6. Correctness Qualities of technical report writing also include correctness. Good technical report must also be correct. It. Must be free from grammatical errors, punctuation mistakes, and should have appropriate format standard. If a report contains grammatical errors, the reader will doubt the accuracy of the information in the report. Technical writing is meant to convey information and to persuade the audience. To accomplish these goals it must be clear accurate, easy to access and must be economical and correct.

4. Differentiate technical writing from literary writing by considering the following: a. Purpose b. Subject matter = More than likely it has something to do with the interests of the author or writer itself as it pertains to the cumulative knowledge gathered to be

presented in such a way as to inform as well as satiate the reader's curiosities. c. Language = d. Point of view = The word tone in literary discussion is borrowed from the expression tone of voice. Tone is the manner in which a poet makes his statement; it reflects his attitude toward his subject. e. Tone = In poetry, tone refers to the feeling of the poem. Tone in Poetry is basically the attitude the poet conveys which can, for example, be comforting or vicious. Lots of the time the tone can start out one way, such as sad, and end up with a different feel by the end of the poem, such as hopeful.

5. Characterize an effective technical report. 6. Discuss the ABCs of technical writing. = The Holistic Guide to Technical Writing: ABC's of Technical Writing 1. Accuracy - must be tactful in the recording of data, statement of calculating mathematical figures. 2. Brevity - it's easier to grasp the main idea of the report written if you have a brief report. 3. Confidence - a writer has to be decisive or sure of what is he writing about. 4. Dignity - ring of authority - all grammatical constructions must be complete, no flowery words. - ideas/info must be well-organized, simplified, summarized & expressed in straightforward manner. 5. Emphasis - stressing the major points & subordinating them. 6. Facility - devices used by the writer. 6.1. Pacing - technical/unfamiliar info should be presented from small to large quantity. 6.2. Sequence - familiar to unfamiliar ; simple to complex. 6.3. Arrangement - significant details should be stressed & balanced to show their

proper relationship. 6.4. Continuity - thought should be clearly established, illustrated, or stated. 7. Grammatical Correctness - reflects the communicative competence of the writer. 8. Honesty - if the writer borrowed some statements, ideas, or quotations, he has to acknowledge them either in footnotes, end-notes, or cite the author or sources. 9. Illustrations 10. Judgement 11. Knowledge 12. Logic 13. Mechanical Neatness 14. Objective 15. Planning 16.Qualification 17. Revision 18. Straight sentences 19. Thoroughness 20. Unity 21. View point 22. Word choice 23. Zest and its meanings

7. Discuss technical writing of the Basis of Language.