Sie sind auf Seite 1von 12

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

Technical writing is writing that is done for the purpose of educating, informing
or directing someone on how to do something. Technical writing is significantly
different than other types of writing such as narrative, because technical writing
is intended to impart to the reader some specific skill or ability. Technical writing
isn't for everyone. It is often very detail-oriented and usually involves writing
within fields where some advanced knowledge is required. When given a
technical writing assignment, it also must be approached in a certain way in
order for you to be successful.

image:
http://www.yourdictionary.com/index.php/image/articles/18779.iStock_88286_S
MALL.jpg

Technical writing is writing that is done for the purpose of educating, informing
or directing someone on how to do something. Technical writing is significantly
different than other types of writing such as narrative, because technical writing
is intended to impart to the reader some specific skill or ability. Technical writing
isn't for everyone. It is often very detail-oriented and usually involves writing
within fields where some advanced knowledge is required. When given a
technical writing assignment, it also must be approached in a certain way in
order for you to be successful.

Forms of Technical Writing


Technical writing assignments normally take one of three forms:
End user documentation
Traditional technical writing
Technological marketing communications
End User Documentation
Writing a manual that accompanies a cell phone
Writing a manual teaching home computer uses how to set up a basic
home networking system
Writing a how-to guide for using laptops

Traditional Technical Writing


Writing an analysis of a legal case for other lawyers
Writing up a summary of a series of medical experiments to be published
in a journal of medicine
Writing an article for a trade publication

Technological Marketing Communications


Writing a sales pitch to a new potential client about a new type of
computer hardware or software
Writing informative articles for the web that show businesses that using a
particular IT consulting service can save them money

Types of Technical Writing Assignments


Technical writing is used in a large variety of fields such as engineering,
computer hardware and software, chemistry, and biotechnology. You can also
find everyday examples of technical writing in owners manuals, employee
handbooks, and in articles on the web.
Some examples of technical writing assignments include:
Training manuals
Operations guides
Promotional brochures
Online articles

Training Manuals
A technical writer may be assigned to compile information for a company or job
training manual. In the manual, the writer may be required to outline:
General information
Company policies
Standard operating procedures
Duties required to be fulfilled by a given position
Training manuals and other company documents can usually be
categorized as end-user documentation.

Operations Guides
When a writer is asked to write an operations guide, they are expected to have a
working knowledge of the topic or area about which they are writing.
It is important that they keep in mind that the people who will be using their
guide will likely be a beginner and will therefore need detailed and concise
instructions for the subject that is being covered. This could refer to any of the
following types of guides:
Assembly instructions
Installation guides
Owners manuals
Computer software guides
Engineering guides
Operations guides typically fall under the traditional technical writing category,
but, in some cases, could also be considered end-user documentation.

Promotional Brochures
A technical writer who writes promotional brochures and other technological
marketing pieces will be required to not only inform a potential customer of the
offer being made, but to entice them to want to avail of it through the use of key
phrases and words.

Online Articles
Another type of technical writing is found in online articles. There is a wealth of
information available on the Internet. Millions of people browse search engines
and read through articles they find for instructions, guides, and to understand
different things.
Technical writing, in this case, could vary from articles on how to assemble a crib
to articles with detailed medical advice or historical information. This area of
technical writing can fall into any of the three categories of technical writing.

Finding Technical Writing Work


As you can see, there are many different types of technical writing assignments.
If you are interested in becoming a technical writer, you should consider working
on both your writing skills and brushing up on your knowledge in your particular
field in order to find the best possible opportunities.

Read more at http://examples.yourdictionary.com/examples-of-technical-writing-


assigments.html#OZRhuCGBiibB9C9D.99

The Society for Technical Communication defines technical communication as any form of
communication that exhibits one or more of the following characteristics: "(1) communicating
about technical or specialized topics, such as computer applications, medical procedures, or
environmental regulations; (2) communicating through technology, such as web pages, help files,
or social media sites; or (3) providing instructions about how to do something, regardless of the
task's technical nature"

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.
The Society for Technical Communication defines technical communication as any form of
communication that exhibits one or more of the following characteristics: "(1) communicating
about technical or specialized topics, such as computer applications, medical procedures, or
environmental regulations; (2) communicating through technology, such as web pages, help files,
or social media sites; or (3) providing instructions about how to do something, regardless of the
task's technical nature"
Overview
Technical writer
Technical writing is performed by a technical writer and is the process of writing and sharing
information in a professional setting. A technical writer's main task is to convey information to
another person or party in the most clear and effective manner possible. The information that
technical writers convey is often complex, and it is one of their main tasks to analyze the
information and present it in a format that is easy to read and understand.. A good technical writer
needs strong writing and communication skills. They do not only convey information through
text, and must be proficient with computers as well. They use a wide range of programs like
Adobe Photoshop to create and edit images, diagramming programs like Microsoft Visio to
create visual aids, and document processors like MadCap Flare to design and format documents.
While commonly associated with online help and user manuals, technical writing covers a wide
range of genres and technologies. Press releases, memos, business proposals, product
descriptions and specifications, white papers, rsums, and job applications are but a few
examples of documents that are considered forms of technical writing
History
While technical writing has only been recognized as a profession since World War II,[6]:2 its roots
can be traced to classical antiquity.[7]:233 Critics cite the works of writers like Aristotle as the
earliest forms of technical writing.[7]:234 Geoffrey Chaucer's work, Treatise on the Astrolabe, is an
early example of a technical document and is considered to be the first technical document
published in English.[
With the invention of the mechanical printing press, the onset of the Renaissance and the rise of
the Age of Reason, the need to document findings became a necessity, and inventors and
scientists like Isaac Newton and Leonardo Di Vinci prepared documents that chronicled their
inventions and findings. While never called technical documents during their period of
publication, these documents played a crucial role in developing modern forms of technical
communication and writing.
The field of technical communication grew during the Industrial Revolution. This increased the
need to instruct people how to use the more and more complex machines that were being
invented and used. However, unlike the past, where skills were handed down through oral
traditions, no one besides the inventors knew how to use these new devices. Writing thus became
the fastest and most effective way to disseminate information, and writers who could document
these devices were desired
During the 20th century, the need for technical writing skyrocketed, and the profession finally
became officially recognized. The events of World War I and World War II led to advances in
medicine, military hardware, computer technology, and aerospace technologies. This rapid
growth, coupled with the urgency of war, created an immediate need for well-designed and
written documents that chronicled the use of these technologies. Technical writing was in high
demand during this time, and became an official job title during World War II
Following World War II, technological advances led to an increase in consumer goods and
standards of living. During the post-war boom, public services like libraries and universities, as
well as transport systems like buses and highways saw massive amounts of growth, and the need
for writers to chronicle these processes increased. It was also during this period that computers
started being used in large businesses and universities. Notably, in 1949, Joseph D. Chapline
authored
The discovery of the transistor in 1947 allowed computers to be produced more cheaply than
ever before. These cheaper prices meant that computers could now be purchased by individuals
and small businesses. And as a result of the computer's growing prominence, the need for writers
who could explain and document these devices grew. The profession of technical writing saw
further expansion during the 1970s and 1980s as consumer electronics found their way into the
homes of more and more people.
In recent years, the prominence of computers in society has led to many advances in the field of
digital communications, leading to many changes in the tools technical writers use. Hypertext,
word processors, graphics editing programs, and page layout software have made the creation of
technical documents faster and easier than ever before, and technical writers of today must be
proficient in these programs.
Techniques
Good technical writing is concise, focused, easy to understand, and free of errors. Technical
writers focus on making their documents as clear as possible, avoiding overly technical phrases
and stylistic choices like passive voice and nominalizations.[3]:236245 Because technical documents
are used in real-world situations, it should always be explicitly clear what the subject matter of a
technical document is and what should be done with the presented information. It would be
disastrous if, for example, a technical writer's instructions on how to use a high-powered X-ray
machine were difficult to decipher.
Technical writing requires a writer to extensively examine his or her audienceA technical writer
needs to be aware of his or her audience's existing knowledge about the material he or she is
discussing because the knowledge base of the writer's audience will determine the content and
focus of a document. For example, an evaluation report discussing a scientific study's findings
that is written to a group of highly skilled scientists will be very differently constructed than one
intended for the general public. Technical writers do not have to be subject-matter experts
(SMEs) themselves and generally collaborate with SMEs to complete tasks that require more
knowledge about a subject than they possess.
Technical writing must be accurate. A technical writer, after analyzing his or her audience, knows
what they're trying to communicate. The goal from there is to convey the message in an accurate
and ethical manner. Physical, environmental, or financial repercussions could result if a writer
does this incorrectly. Knowing the audience is important to accuracy because the language will
be tailored according to what they understand about the subject at hand. For example,
instructions on how to correctly and safely build a bookshelf are included when purchased.
Those instructions are constructed so that anyone could follow along, as well as accurate details
as to where every fastener goes. If those instructions were inaccurate, the bookshelf could be
unstable and result in falling, and possibly injure someone.
Document design and layout are also very important components of technical writing. Technical
writers spend much time ensuring their documents are laid out in a fashion that makes readability
easy, because a poorly designed document hampers a reader's comprehension. Technical
document design stresses proper usage of document design choices like bullet points, font-size,
and bold text. Images, diagrams, and videos are also commonly employed by technical writers
because these media can often convey complex information, like a company's annual earnings or
a product's design features, far more efficiently than text
Technical documents
Technical writing covers many genres and writing styles depending on the information and
audience. Technical documents are not solely produced by technical writers. Almost anyone who
works in a professional setting produces technical documents of some variety. Some examples of
technical writing include:
1. Instructions and procedures are documents that help either developers or end users
operate or configure a device or program. Examples of instructional documents include
user manuals and troubleshooting guides for computer programs, computer hardware,
household products, medical equipment, mechanical products and automobiles.
2. Proposals. Most projects begin with a proposala document that describes the purpose
of a project, the tasks that will be performed in the project, the methods used to complete
the project, and finally the cost of the project. Proposals cover a wide range of subjects.
For example, a technical writer may author a proposal that outlines how much it will cost
to install a new computer system, a marketing professional may write a proposal with the
product offerings and a teacher may write a proposal that outlines how a new biology
class will be structured.
3. Emails, letters, and memoranda are some of the most frequently written documents in a
business. Letters and emails can be constructed with a variety of goalssome are aimed
at simply communicating information while others are designed to persuade the recipient
to accomplish a certain task. While letters are usually written to people outside of a
company, memoranda (memos) are documents written to other employees within the
business.
4. Press releases. When a company wants to publicly reveal a new product or service, they
will have a technical writer author a press release, a document that describes the product's
functions and value to the public.
5. Specifications are design outlines that describe the structure, parts, packaging, and
delivery of an object or process in enough detail that another party can reconstruct it. For
example, a technical writer might diagram and write the specifications for a smartphone
or bicycle so that a manufacturer can produce the object.
6. Descriptions are shorter explanations of procedures and processes that help readers
understand how something works. For example, a technical writer might author a
document that shows the effects of greenhouse gases or demonstrates how the braking
system on a bike functions.
7. Rsums and job applications are another example of technical documents. They are
documents that are used in a professional setting to inform readers of the author's
credentials.
8. Technical reports are written to provide readers with information, instructions, and
analysis on tasks. Reports come in many forms. For example, a technical writer might
evaluate a building that is for sale and produce a trip report that highlights his or her
findings and whether or not he or she believes the building should be purchased. Another
writer who works for a non-profit company may publish an evaluation report that shows
the findings of the company's research into air pollution.
9. Case study is a published report about a person, group, or situation that has been studied
over time; also : a situation in real life that can be looked at or studied to learn about
something. For example, an individual's challenging situation at his or her workplace and
how he or she resolved it is a case study.
10. White papers are documents that are written for experts in a field and typically describe
a solution to a technological or business challenge or problem. Examples of white papers
include a piece that details how to make a business stand out in the market or a piece
explaining how to prevent cyber-attacks on businesses.
11. Web sites. The advent of hypertext has changed the way documents are read, organized,
and accessed. Technical writers of today are often responsible for authoring pages on
websites like "About Us" pages or product pages and are expected to be proficient in web
development tools.
Tools
The following tools are used by technical writers to author and present documents:
1. Desktop publishing tools or word processors. Word processors such as Scrivener,
Microsoft Word, Apple Pages, and Open Office Writer are used by technical writers to
author, edit, design, and print documents. Since technical writing is as much about the
page's layout as it is the written language, Desktop Publishing tools such as Adobe
FrameMaker and LyX are also used by Technical Writers. These programs function
similarly to word processors but provide users with more options and features for the
document's design and automate much of the formatting.
2. Help authoring tools are used by technical writers to create the help systems that are
packaged with software products, delivered through web browsers or provided as files
users can view on their computers. When writing instructional procedures for incredibly
complex programs or systems, technical writers will use these tools to assist them and
simplify the process. Adobe RoboHelp, MadCap Flare and HelpNDoc are a few
examples of Help Authoring Tools.
3. Image editing software. Often, images and other visual elements can portray
information better than paragraphs of texts. In these instances, image editing software
like Adobe Photoshop and GIMP are used by technical writers to create and edit the
visual aspects of documents like photos, icons, and diagrams.
4. Collaborative software programs. Because technical writing often involves
communication between multiple individuals who work for different companies, it can be
a collaborative affair. Thus, technical writers use Wiki Systems like MediaWiki , eXo
Platform and Atlassian Confluence and shared document workspaces like Microsoft
SharePoint and Google Docs to work with other writers and parties to construct technical
documents.[3]:74
5. Web development tools. Technical writers' jobs are no longer limited to just producing
documents. They must now also produce content for company's corporate and other
professional web sites. Web Development Tools like Adobe Dreamweaver are standard
tools in the industry that technical writers are expected to be proficient in.
6. Graphing software. In order to portray statistical information like the number of visits to
a restaurant or the amount of money a university spends on its sporting programs,
technical writers will use graphs and flowchartsWhile programs like Microsoft Excel and
Word can create basic graphs and charts, sometimes technical writers must produce
incredibly complex and detailed graphs that require functions not available in these
programs. In these instances, powerful graphing and diagramming tools like Microsoft
Visio are used to effectively organize and design graphs and diagrams.
7. Screen capture tools Technical writers commonly use Screen Capture Tools like
Camtasia Studio and Snagit to capture their desktops. When creating instructions for
computer software, it's much easier for a technical writer to simply record themselves
completing a task than it is to write a lengthy series of instructions that describe how the
task must be performed. Screen capture tools are also used to take screenshots of
programs and software running on user's computers and then to create accompanying
diagrams.

How to Write a Business Letter - Sample and Tips


A business letter is a formal means of communication between two people, a person and a corporation, or two
corporations. Business letters differ from personal letters because they follow very strictly set rules for composition.
Many people are intimidated by the prospect of writing to strict guidelines, however business letters are nothing to be
afraid of. They are too useful a tool to be stigmatized by the public.
Before you begin writing, answer the following questions:

1. What is my purpose in writing this letter/memo/report?


2. What does my reader want or need to know to understand my message?
3. Have I answered important questions and provided the necessary information for the reader?
4. Did I accomplish my purpose?
5. Have I included boring, confusing, or distracting information?
6. What do I want the reader to do when he or she is done reading this?
7. Is that clear to the reader?
8. Have I included all the information necessary for the reader to take this action?
DEFINITION OF A BUSINESS LETTER

A business letter serves the main purpose of communication between two companies, or it is a method to talk to
different people within a business.

PURPOSE OF A BUSINESS LETTER


The purpose for business writings is to inform readers of information you want to get across or possibly persuade the
readers to do something.

THE 7 C 's OF BUSINESS WRITING

Most problems with business letters are they are either hard to understand or very long and drawn out. One solution
that many writers use to correct this problem is to double check the writing to make sure it follows the seven C's of
business writing. The seven C's are:
Clear
Concise
Correct
Courteous
Conversational
Convincing
Complete
If you as a writer are able to effectively do all or part of these seven guidelines, then your paper
will be on its way to being a good business letter.

1.
Correctness
At the time of encoding, if the encoder has comprehensive knowledge about the decoder of
message, it makes the communication an ease. The encoder should know the status, knowledge
and educational background of the decoder. Correctness means:

Use the right level of language


Correct use of grammar, spelling and punctuation
Accuracy in stating facts and figures
Correctness in message helps in building confidence.

2. Clarity
Clarity demands the use of simple language and easy sentence structure in composing the
message. When there is clarity in presenting ideas, its easy for the receiver/decoder to grasp the
meaning being conveyed by the sender/encoder.

Clarity makes comprehension easier.

3. Conciseness
A concise message saves time of both the sender and the receiver. Conciseness, in a business
message, can be achieved by avoiding wordy expressions and repetition. Using brief and to the
point sentences, including relevant material makes the message concise. Achieving conciseness
does not mean to loose completeness of message.

Conciseness saves time.

4. Completeness
By completeness means the message must bear all the necessary information to bring the
response you desire. The sender should answer all the questions and with facts and figures. and
when desirable, go for extra details.

Completeness brings the desired response.

5. Consideration
Consideration demands to put oneself in the place of receiver while composing a message. It
refers to the use of You attitude, emphases positive pleasant facts, visualizing readers problems,
desires, emotions and his response.

Consideration means understanding of human nature.

6. Concreteness
Being definite, vivid and specific rather than vague, obscure and general leads to concreteness of
the message. Facts and figures being presented in the message should be specif.

Concreteness reinforces confidence.

7. Courtesy
In business, almost everything starts and ends in courtesy. Courtesy means not only thinking
about receiver but also valuing his feelings. Much can be achieved by using polite words and
gestures, being appreciative, thoughtful, tactful, and showing respect to the receiver. Courtesy
builds goodwill.
Courtesy strengthen relations.

KEEPING YOUR LETTER TO THE POINT

The first thing you need to make sure of when writing a business plan is to make sure that you
are not wasting the readers time. There are two questions to make sure that you are not wasting
their time and they are, "why am I writing" and "what do I want to achieve." If you are able to
answer theses two questions then, then you writing will be a third of what it would have been if
you as a writer just sat down and started to write. It is a good thing that your letter is short
because that way you are getting straight to the point of what you want you readers to know.

COMMON TYPES OF BUSINESS LETTERS

There are many different types of business letters that a person can write to achieve different
things. The key to writing a letter that will achieve what you want is to know what type of letter
you are writing. The different types of letters are: acknowledgement, adjustment, complaint,
inquiry, order, and response letter.

Acknowledgement letter = This letter is meant to thank the reader for something they did for you
in the office.
It could simply be saying thanks for receiving something the reader sent or maybe thanking them
for their help with something. This type of letter is not required in a business environment, but it
is appreciated.

Adjustment Letter = This letter should be used in response to a written complaint against
someone or
something. The purpose of it is to inform the reader that actions are being taken against the
wrong doing as well as it serves as a legal document acknowledging the complaint.

Complaint Letter = The complaint letter is much like the adjustment letter except no wrong
doing as taken
place. Instead, this letter is just to let the reader know that an error as been found and needs to be
corrected as soon as possible. Once again, this letter is a legal document letting the reader know
that something is being done to correct the problem.

Inquiry Letter = An inquiry letter is written as a request for a certain something or in response to
a request made by someone. The object of the inquiry letter is to get the object or material
requested in the letter.

Order Letter = Order letters are exactly as they sound, they are used to order material that is
running low and will be needed soon. This type of letter is commonly known as a PO (purchase
order). This letter is also a legal document showing a transaction between a business and a
vendor.

Response Letter = A response letter is also exactly how it sounds. It is a letter written in response
to another letter received by someone. The objective of this type of letter is to fulfill the request
made by the person you are writing this letter to.

BUSINESS WRITING CHECKLIST

Once you have completed your business letter, there is a checklist that you can go through in
order to make sure you letter is up to par. The basic idea of the checklist is to make sure the letter
is: short, simple, strong, and sincere. If you go back and find that your letter has all of these
qualities, then there is a good chance you have written an effective business letter.

Das könnte Ihnen auch gefallen