LESSON 4 INTRODUCTION TO TECHNICAL WRITING ✓ Purpose of the paper ✓ Choice of topic ✓ Gathering information What is writing? - - - - - - Writing is the process of using symbols (letters in the alphabet, punctuations, and spaces) to communicate our thoughts and ideas in a readable form. Writing is the fourth of the five macro skills (listening, speaking, reading, writing, and viewing) in learning a language. Having good writing skills allow people to communicate clearly with others and create useful resources. Generally, we write using a pen or a pencil (handwriting) or a keyboard (typing). With a pen or a pencil, we usually write on a surface such as paper or whiteboard. Voice recognition programs allow those who cannot see or use their hands to have their thoughts transcribed. To write clearly, it is of utmost importance for one to understand the basic system of a language. In English, this will include knowledge of grammar, punctuation, and sentence structure. Writing stage - ✓ Don’t exaggerate overanalyze your writing. and ✓ Work on the details as much as possible to keep the story fresh in your mind. Do have fun as well. ✓ Don’t worry yet about how good your writing is. Re-writing stage - Pre-writing stage this is the first stage in the writing process. It is what the writer does before he writes the first draft. In this stage, the writer composes or supplies information pertaining to: details ✓ Feel free to follow the flow of ideas and where it leads you. The Writing processes - it is the part where we begin to write our first draft. We know that not everything we write is perfect at the first go. Hence, we must remember what to do and what not to do during this stage. this is also known as the “revision stage.” We revise to ensure that: ✓ The content of the paper is relevant. ✓ There is organization and coherence is the arrangement of ideas. ✓ Grammar and mechanics are observed well. TECHNICAL WRITING - Technical writing is writing about scientific subjects and about - - - various technical subjects associated with the sciences, engineering, and other skilled trades (Mills and Walter, 1981). Technical writing is characterized by certain formal elements, such as its scientific and technical vocabulary, its use of graphic aids, and its use of conventional report forms (Mills and Walter, 1981) Technical writing is ideally characterized by the maintenance of an attitude of impartiality and objectivity, by extreme care to convey information accurately and concisely, and by the absence of any attempt to arouse emotion (Mills and Walter, 1981). In general, technical writing has a degree of formality, and it generally focuses on a specific subject with the purpose of making something happen or sharing useful information or knowledge. TECHNICAL WRITER - - - - A technical writer is someone who can explain complicated and difficult concepts in clear, easy-tounderstand prose. Technical writers are expert communicators and translators. They also have strong organization skills. They start with a complicated piece of technology, and their mission is to explain how to use that piece of technology to a nonexpert in a brief and comprehensible manner. LESS IS BEST and CONCISION MATTERS. PRINCIPLES WRITING OF TECHNICAL Always have in mind a specific reader when you are writing a technical writing Sassignment. Always assume that he is intelligent but uninformed. Before you start to write, always decide what the exact purpose of your report is, and make sure that every paragraph, every sentence, every word makes a clear contribution to that purpose. The following are the principles of good technical writing that separate a talented technical writer to an ordinary writer: Use language that is simple, concrete, and familiar. At the beginning and end of every section of your report, check your writing according to this principle: “first you tell the reader what you’re going to tell him, then you tell him what you’ve told him.” Make your report attractive. The following are the purposes of technical writing that set it apart from other forms of writing: It serves as basis for management decision. It furnishes needed information. It gives instructions. It records business transactions through proposals. It procures business proposals. It serves as basis for public relations. It provides report to stockholders of companies. ATTRIBUTES WRITING OF TECHNICAL It pertains to a technical subject – technical writing must pertain to some aspect of engineering or the sciences in a given subject area such as the following: ✓ Philosophy, religion leave it out. Also, a report without facts or scientific evidence to support an opinion usually lacks credibility, and it is likely to be unsuccessful in achieving its purpose and objective. psychology, It is impersonal - and ✓ Geography and anthropology ✓ Social science and political science - ✓ History, law, and education ✓ Language and literature ✓ Science and medicine ✓ Agriculture, technology, and fine arts It is concise - It has a purpose - a technical document is always written for a reason, and the purpose of reports may be to explain what was done, why it was done, and/or the results of a study. The purpose must also be clearly stated. - It conveys information, facts, and data - technical writing should have substance in every statement. If a sentence does not convey information pertinent to a study, the use of first-person pronouns is usually discouraged in technical writing. The intrusion of “I” makes the work less authoritative. Similarly, it is inappropriate to use names of people and trade names unless there is no other way to describe the item. ATTRIBUTES OF TW Personal pronouns and names should be omitted because they are unnecessary. Trade and people’s names should also be avoided because of some liability concerns and considerations. - technical reports are usually written for business reasons. They are not intended to entertain; they communicate information to an identified person or group. Wandering sentences and extra words reflect badly on the author and often have a negative effect on the readership that you are trying to reach. Circumlocution or the use of unnecessarily large number or excessive number of words to express an idea is not encouraged. Circumlocutions can be replaced by punctuation marks or conjunctions. - Every technical writer should strive to state his or her message with the fewest words. It is because those people who read technical documents are busy. Extra words mean extra work for them and that they like your document less. It is directed to readers - - - Technical reports must be directed to a particular readership. The technical writer is responsible for determining the specific individuals or parties who will receive a technical document. it is performed with a particular style and format – the attributes of technical writing also include style and format. ✓ Style is the way that you write. It must be objective and not subjective. Format is the ordering and physical layout of a document. The appropriate style for technical writing is objective. Technical documents present data, facts, calculations, test results, and theories, and these must be presented in an accurate manner that is not opinionated. The format (the basic elements and their placement) of technical papers and reports is more structured than those used in other forms of writing. Formal technical writings usually start with introduction, procedure, results, discussion, conclusion, and recommendations. It is archival - technical writing must be written in a manner that it can be archived and produce valuable and usable information in the future. Conversely, technical documents should not be generated on transient issues or subjects that will not be pertinent in the future. It cites contributions of others - formal technical reports and works must show sources of information and recognize contributions of others by citing them either inside or at the end of the document. ✓ It works the same when we are referencing theses and dissertations. LESSON 5: TECHNICAL WRITING CREATIVE WRITING VS. TYPES OF WRITING THAT IS NOT TECHNICAL Advertisement - it is a short announcement or notice that promotes a product, brand, or service to the public in order to attract interest, engagement, and sales. They are not considered technical writing because most of them are not factual. Advertisements always use the words “best” and “superior” among others, when in fact, they are really not. Opinion - - an opinion is a view or judgment formed about a topic that is not necessarily based on fact or knowledge. Personal opinions are not part of technical writing as they belong on the editorial pages of newspapers. An editorial page is a section in a newspaper that contains articles known as “editorials.” Editorials give views or opinions of the editor or publisher on certain issues or events Creative writing - - creative writing requires saying things in words that create illusions or that establish a mood or other desired effect. It can be just humorous or entertaining like a murder mystery. A characteristic of this type of writing is the use of expressive and descriptive language. Poetry and other forms of fiction are included in this category of writings Technical writing refers to the practice of documenting processes. It explains how something works to a specific audience. Technical writing has a degree of formality, and it generally focuses on a specific subject with the purpose of making something happen or sharing useful information or knowledge. Creative writing is a piece of writing which focuses on imaginative and symbolic content that are published to entertain, provoke, and inspire the user. A creative paper gives readers a theme, message, moral, or lesson that is helpful in their real lives or gives them temporary entertainment. Creative writing may come in many forms. It encompasses several genres and styles. Some of which are the following: - Biographies Fiction (novels, short stories, fables, etc.) Poetry and spoken word poetry Playwriting/scriptwriting Personal essays Speeches TECHNICAL WRITING Technical writing is based on facts and real concepts. Technical writing focuses on evidential and straightforward content. CREATIVE WRITING is based on imaginations and creativity. Creative writing focuses on imaginative and symbolic content. Technical writing has its specific reader or audience. The purpose of technical writing is to inform, instruct, and educate the user. Creative writing has general reader or audience. The purpose of technical writing is to inform, instruct, and educate the user The purpose of creative writing is to entertain, provoke, and inspire readers or users. Technical Writing It follows formal and standard style of writing. It gives readers information about some technical topics, or it gives directions on how to do something. Creative Writing It follows informal and artistic style of writing. It gives readers a theme, message, moral, or lesson that is helpful in their real lives or gives a temporary entertainment to the reader. Technical Writing It uses text features like the table of contents, index, labels, charts, photos, and graphs. The tone of technical writing is objective. Creative Writing It uses many narrative elements such as conflict, character, theme, setting, and resolution. The tone of creative writing is subjective. processes. It is used for writing user manuals, case studies, theses, etc. Creative writing depends on the author’s unique voice, thoughts, ideas, and imaginative manner. Creative writing is generally seen in storytelling, novels, blogs, and other types of fiction. LET US REMEMBER! Technical Writing It is organized in a very systematic and sequential manner. In technical writing, graphics are included to give more information to the topic. Creative Writing It is organized in an arbitrary and artistic manner and may not be systematic. In creative writing, graphics are included to give more attraction to the topic. Technical writing depends on any result, research, data, information, etc. Technical writing is used for documenting Technical writing communicates issues in engineering, sciences, and skilled trades. Technical writing has rigid form and style requirements that are different from those of other types of writing. Technical writing does not employ humor or slang. Technical writing is objectiveoriented. Technical writing does not blame people. It helps them. Technical writing requires facts, data, and evidence. Technical writing never hides facts. Technical writing is never used as an advertising copy. Technical writing is impersonal—it does not use personal pronouns (like I or we) or name people who performed parts of the work.
