historical background of technical writing

8
1. Historical background of Technical Writing. Technical Documentation has been around for several centuries. Especially with the continuous launch and upgrade of technically advanced products and services, user guides and technical descriptions are needed. Who was the first technical writer? Quite likely Cro-Magnon man when was drawing on his cave walls. However, most experts would agree that technical documentation appeared as early as the 14th century. Geoffrey Chaucer detailed the purpose and operation of a navigation device. Copernicus, Hippocrates, Newton and Leonardo da Vinci wrote explanatory notes to demonstrate the use of their inventions. All these publications can be seen as technical documentation. But the golden age of technical writing started with the invention of the computer and the need for mass technical documentation. It started during World War II with the major technological upgrade manufacturing weapons and the creation of nuclear technologies. Modern day technical documentation is linked to computer science in general and internet in particular. Needless to say, the growth in technology users has sparked the need for technical documentation. The growth in technical products and services has created the demand for professional documentation. This has created a new profession: technical writing. A good technical writer is an honest mediator between people who create technology and who use technology.

Upload: carlo-gulapa

Post on 13-Sep-2015

215 views

Category:

Documents


1 download

DESCRIPTION

History of Technical Writing

TRANSCRIPT

1. Historical background of Technical Writing.Technical Documentation has been around for several centuries. Especially with the continuous launch and upgrade of technically advanced products and services, user guides and technical descriptions are needed.Who was the first technical writer? Quite likely Cro-Magnon man when was drawing on his cave walls. However, most experts would agree that technical documentation appeared as early as the 14th century.Geoffrey Chaucer detailed the purpose and operation of a navigation device. Copernicus, Hippocrates, Newton and Leonardo da Vinci wrote explanatory notes to demonstrate the use of their inventions. All these publications can be seen as technical documentation.But the golden age of technical writing started with the invention of the computer and the need for mass technical documentation. It started during World War II with the major technological upgrade manufacturing weapons and the creation of nuclear technologies.Modern day technical documentation is linked to computer science in general and internet in particular. Needless to say, the growth in technology users has sparked the need for technical documentation.The growth in technical products and services has created the demand for professional documentation. This has created a new profession: technical writing. A good technical writer is an honest mediator between people who create technology and who use technology.The domain of technical writers has recently expanded to a more interactive one. Technical writing has evolved from pure technical writing into technical communicating.Reference: A Brief History Of Technical Writing, Webmaster Blog, May 5, 20112. What is Technical Writing?Technical writing is any written form of writing or drafting technical communication used in a variety of technical and occupational fields, such as computer hardware and software, engineering, chemistry, aeronautics, robotics, finance, consumer electronics, and biotechnology. IT encompasses the largest sub-field within technical communication.Reference: What is Technical Communications? TechWhirl. Accessed December 9, 20143. Five basic principles of Technical Writing. ContentFive basic questions who, why, what, how and when are applied in various situations to develop the content for any kind of a document. For instance, imagine a situation where you have to create a report based on your balance sheet. Before creating a report, you can plan the content of your report by applying following key questions to the situation: OrganizationWriters use an organizational pattern so that it gives consistency to writing. Organizational pattern provide the document with continuity so that audience can comprehend the ideas. For example, writers can organize their ideas chronologically, spatially and categorically. StyleWriters change their style depending on the audience. A person would not write an e-mail to a close friend in the same style as a formal memorandum to a manager. Writers adopt either formal or informal styles, depending on the writing situation. Accessibility and SpecificityAccessibility refers to the ease at which the audience can gain the information they need from a document. Table of contents, headers, footers, page numbers, headings and sub headings help make the document more accessible for the intended audiences. Conventional Grammar and MechanicsWriters adhere to the rules of conventional grammar and mechanics. Technical writers essentially proofread and edit the document for detecting and correcting errors in graphics, typography and layout.Reference: https://aashitashekhar.wordpress.com/2010/04/07/principles-of-technical-writing/

4. Characteristics of Technical Writing.The following are the characteristics of technical writing:Addresses a specific audience, topic and purposeAudienceTechnical writers identify the readers to whom they are writing evaluate what they require of the documentation and determine why they will use documentation. They classify the readers by three main characteristics: Education Knowledge and experience levels Expectations and needs Based on the knowledge level, you can categorize the audience as novice, intermediary or experienced user. The content of the document will vary depending on the categorization.TopicTopic involves the gist of what technical writers are planning to write about. For example, in a document that explains how the retailer book an order with the wholesaler, the topic will be Booking an Order.PurposePurpose will reflect the activity the audience wants to be able to perform after reading the document.Your purpose could be: To inform to provide the information without expecting any action on the part of the reader. To instruct to give information in the form of directions, instructions,procedures, so that readers will be able to do something. To propose to respond to a request for proposals (RFP) or to suggest a plan of action for a specific problem. To recommend to suggest an action or series of actions based onalternative possibilities that have been evaluated. To persuade: to convince readers to take action, to change their attitudes or behaviors based on valid opinions and evidence.Has structured contentThe structure of the document is an important aspect of the documentation development. It would depict how one section would flow into another and the segregation between chapters and appendicesIs objectiveTechnical writing is rarely about opinion. Technical writing is grounded in fact. While writing facts, care is needed to ensure that any assumption, conjecture, extrapolation, generalisation, opinion or possibly mentioned early in the document is not later referred to as if it were a fact. Technical writers rely on evidence and not authority.Uses simple and objective languageTechnical writers keep sentences as short and simple as is possible and appropriate for the subject matter and audience. A long and complex sentence can be difficult to comprehend.Uses IllustrationsTechnical writers consider tables and illustrations as part of a document, not as ornament. They complement the writing. They do not add them at the end as if they were an afterthought. Instead when planning a composition, they consider how information or ideas can be best conveyed to the readers they have in mind- in words, numbers, tables or illustrations.Is presented consistentlyTechnical writers are consistent in use of headings, names, terms, abbreviations and symbols; in spelling and punctuation.Reference: What are the characteristics of technical writing? Aashita Shekhar, April 16, 2010

5. Differences between Formal-Academic versus Informal Writing.Informal: May use colloquial words/expressions (kids, guy, awesome, a lot, etc.).Formal: Avoid using colloquial words/expressions (substitute with children, man/boy, wonderful, many, etc.)

Informal: May use contractions (cant, wont, shouldnt, etc.).Formal: Avoid contractions (write out full words cannot, will not, should not, etc.).

Informal: May use first, second, or third person.Formal: Write in third person (except in business letters where first person may be used).

Informal: May use clichs (loads of, conspicuous by absence, etc.) Formal: Avoid clichs (use many, was absent, etc.)

Informal: May address readers using second person pronouns (you, your, etc)Formal: Avoid addressing readers using second person pronouns (use one, ones, the reader, the readers, etc.)

Informal: May use abbreviated words (photo, TV, etc)Formal: Avoid using abbreviated words (use full versions like photograph, television, etc.)

Informal: May use imperative voice (e.g. Remember.)Formal: Avoid imperative voice (use Please refer to..)

Informal: May use active voice (e.g. We have noticed that..)Formal: Use passive voice (e.g. It has been noticed that.)

Informal: May use short and simple sentences.Formal: Longer and more complex sentences are preferred (short simple sentences reflects poorly on the writer)

Informal: Difficulty of subject may be acknowledged and empathy shown to the reader.Formal: State your points confidently and offer your argument firm support.

Reference: http://www.word-mart.com/html/formal_and_informal_writing.html

Far Eastern UniversityInstitute of Architecture and Fine Arts

ASSIGNMENTENG 8

GULAPA, CARLO P.2012458331 - AR1241June 26, 2015

PROF. RAMIL A. MONDEJARProfessor