Lesson 1 – 2 Flashcards
any communication that results in the proper documentation of any matter pertaining to various aspects related to your job or business
Technical Writing (Arao)
may be written by technical writers, engineers, computer analysts, managers, marine otticers, secretaries, scientists, and even ordinary seafarers
Technical Writing (Arao)
takes the form of a memo, proposal, letters, reports, manuals, or any form of written communication used in our everyday business
Technical Writing (Arao)
a specialized, structured way of writing, where information is presented in a format and manner that bests suits the cognitive and psychological needs of the readers, so they can respond to a document as its author intended and achieve the purpose related to that document
Technical Writing
the process of gathering information from experts and presenting it to an audience in a clear, easy to understand form
Technical Writing
umbrella term for any sort of professional communication, the interface between your ideas and the rest of the world
Technical Writing
the presentation of information that helps the reader solve a particular problem
Technical Writing
They write, design, or edit proposals, manuals, web pages, lab reports, newsletters, and many other kinds of professional documents.
Technical Communicators
an exposition about scientific subjects and about various technical subjects associated with science and technology
Technical Writing (Rosales et al.)
characterized by certain formal elements, such as its scientific and technical vocabulary, and its use of conventional report forms
Technical Writing (Rosales et al.)
ideally characterized by the maintenance of impartiality and objectivity, by extreme care to convey information accurately and concisely, and by the absence of any attempt to arouse emotion
Technical Writing (Rosales et al.)
writing where there is a relatively high concentration of certain complex and important writing techniques, in particular, definition, description of a mechanism, description of a process, classification, and interpretation
Technical Writing (Rosales et al.)
writing where there is a relatively high concentration of certain complex and important writing techniques, in particular, definition, description of a mechanism, description of a process, classification, and interpretation
Technical Writing (Rosales et al.)
Two Subjects of Technical Writing
Tangible & Abstract
A type of writing where the author is writing about a particular subject that requires direction, instruction, or explanation
Technical Writing
Content, Purpose, Style, Tone, Audience, Vocabulary & Organization of Technical Writing
Scientific, Technical
To inform, instruct, persuade
Simple, Direct
Concise, direct, uses descriptive or instructive approach
Academe, professional, other technical fields
Specialized
Sequential, systematic
Content, Purpose, Style, Tone, Audience, Vocabulary & Organization of Literary Writing
Deals with life itself, human experiences
To entertain, to amuse
Wordy, elaborate
Narrative, uses rhetorical devices
General public
General, evocative
Arbitrary, artistic
3 Purposes of Technical Writing
- To Inform
- To analyze events and their implications
- To persuade and influence decisions
Functions of Technical Writing
- To serve as a basis for management decisions
- To furnish needed information
- To give instructions
- To explain techniques
- To report achievements
- To analyze problem areas
- To determine design and system requirements
- To serve as a basis for public relation
- To provide report to stockholders of companies
- To develop a product
- To provide service
- To record business through proposals
- To procure business through proposals
3 Types of Technical Write-ups in Various Professions
- Traditional Technical Documents
- End-user Document
- Technical Marketing Communications
informative or instructional documents that are developed and written for an audience already familiar with a specific technical area
Traditional Technical Documents
language used in these documents must be clear and concise in order for the audience to understand what the writer desires
Traditional Technical Documents
technical documents designed to help the general public understand how to use an item
End-user Document
usually part of a consumer product and include operating manuals, assembly instructions, information booklets and trouble-shooting guides
End-user Document
What issues do writers of end-user documents must consider and what should they do about it?
Issues the consumer might face when assembling or using a product. Writers should provide clear instructions and solutions to any potential problems.
an instruction manual is a best example of this document
End-user Document
should be written using terms the general public understands since the readers of these documents vary in abilities and educational backgrounds
End-user Document
means any form of communication that focuses on technical or specialized topics, communicates specifically by using technology or provides instructions on how to do something
Technical Marketing Communications
TTD, EUD, or TMC?
Abstract
TTD
TTD, EUD, or TMC?
Manuals
TTD
TTD, EUD, or TMC?
Journal
TTD
TTD, EUD, or TMC?
Business Letter
TTD
TTD, EUD, or TMC?
Memorandum
TTD
TTD, EUD, or TMC?
Report
TTD
TTD, EUD, or TMC?
Project Proposal
TTD
TTD, EUD, or TMC?
Specifications
TTD
TTD, EUD, or TMC?
Owner’s Manual
EUD
TTD, EUD, or TMC?
Brochure
TMC
TTD, EUD, or TMC?
Flyer/Flier
TMC
- a brief summary of a research article, thesis, review or any in-depth analysis of a particular subject and is often use to help the reader quickly ascertain the paper’s purpose
- always appears at the beginning of a manuscript or typescript acing as the point of entry of any given academic paper
Abstract
- books of instructions specially for leaming a subject which contain specific information on a specific topic, activities, and exercises
Manuals
- a publication which is produced on a continuing basis either weekly, monthly, quarterly, and annually
Journal
- written in formal language usually used when writing from one business organizaion to another, or for correspondence between such organizations and their customers, clients, and other external parties
Business Letter
- a form of written communication circulated within the company and its branches which is used to disseminate a message or information
Memorandum
- a specific form of writing that is organized to concisely identify and examine issues, events, or findings that have happened in a physical sense such as events that have occurred within an organization or findings from a research investigation
Report
- a document that is used to convince a sponsor that a project needs to be realized to solve a particular business problem or opportunity
- describes the depth, how the project is going to be commenced so that the sponsor understands what is involved early
Project Proposal
- often refers to a set of documented requirements to be satisfied by a material, design, product or service
- a detailed description of design criteria for a piece of work
Specifications
- also called an instruction manual or a user guide
- an instructional book or booklet that is supplied with almost all technologically advanced consumer products such as gadgets, vehicles, home appliances, and computed peripherals
Owner’s Manual
- an informative paper document for advertising which can be folded onto a template, pamphlet, or leaflet
- promotional documents primary used to introduce a company, organization, products, or services and inform potential customers or members of their public benefits
- usually distributed inside a newspaper, handed out personally, or placed in a brochure rack
Brochure
- a form of paper advertisement intended for wide distribution and typically posted or distributed in public place, handed out to individuals or sent through the mail
- usually unfolded printed sheet that is used to draw attention to an event, service, product or ideas
Flyer/Flier
strictly a record of personal and daily experiences
Diary
could be a more general record or logbook but more importantly a technical journal that is scientific or industry-related publication or periodical
Journal
expected to give more in-depth information and instruction than a guide
Manual
shorter, concise, and more direct to the point than a manual
Guide
a brief summary of your entire study which includes the aim or objective, methods, results, and conclusions that gives the highlight of your work
Abstract
includes only some of the elements of what is in an abstract
Introduction
something that can be seen or touched, such as a computer or software program, or information on how to assemble a piece of furniture
Tangible
something that involved a series of steps that aren’t related to a tangible object
Abstract
T/F: In writing a technical report, there should always be a target audience.
True
T/F: Words and expressions in technical writing may not be properly selected
False
T/F: An effective technical report arouses the emotions of the reader.
False
T/F: Style of technical writing can be elaborate but also simple and direct.
False
T/F: Good writing skills are highly important in one’s work place.
True
T/F: Technical writing does not greatly differ from other forms of writing except its content, purpose, style, tone, vocabulary, organization, and audience.
True
T/F: Abstract language is preferred when writing a technical report even onboard the vessel.
False
T/F: The way you write will not only improve your good communication skills but also will be affected by how you are being perceived by others in the work place.
True
T/F: In the maritime field, one should have enough knowledge on the maritime terms in making correspondence.
True
T/F: Technical reports may or may not deal with factual information because after all, it utilizes technical vocabulary.
False
