Академический Документы
Профессиональный Документы
Культура Документы
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, 2011
2. 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,
2014
https://aashitashekhar.wordpress.com/2010/04/07/principles-of-
Audience
Technical 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.
Topic
Topic 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.
Purpose
Purpose 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 on
alternative 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.
Technical 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 language
Technical 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 Illustrations
Technical 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 consistently
Technical 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
ASSIGNMENT
ENG 8
GULAPA, CARLO P.
2012458331 - AR1241
June 26, 2015