What is Technical Writing?

Technical writing is sometimes defined as simplifying the complex. Inherent in such a concise and deceptively simple definition is a whole range of skills and
characteristics that address nearly every field of human endeavor at some level. A significant subset of the broader field of technical communication, technical
writing involves communicating complex information to those who need it to accomplish some task or goal.
Oxford Dictionaries Online (ODO) provides four definitions for the word technical, all of which relate to the profession of technical writing:
of or relating to a particular subject, art, or craft, or its techniques
of, involving, or concerned with applied and industrial sciences
resulting from mechanical failure
according to a strict application or interpretation of the law or rules
With these definitions in mind, it’s easy to see that technical writing has been around as long as there have been written languages. Modern references to
technical writing and technical communications as a profession begin around the time of World War I as technical developments in warfare, industry and
telecommunications began to evolve more rapidly. Although many people today think of technical writing as creating manuals for computers and software, the
practice of technical writing takes place in any field or industry where complex ideas, concepts, processes or procedures need to be communicated. In fact, the
US Bureau of Labor Statistics defines technical writers as those who “…put technical information into easily understandable language. They work primarily in
information-technology-related industries, coordinating the development and dissemination of technical content for a variety of users; however, a growing number
of technical communicators are using technical content to resolve business communications problems in a diversifying number of industries.”
The Goal of Technical Writing
Good technical writing results in relevant, useful and accurate information geared to specifically targeted audiences in order to enable a set of actions on the part
of the audience in pursuit of a defined goal. The goal may be using a software application, operating industrial equipment, preventing accidents, safely consuming
a packaged food, assessing a medical condition, complying with a law, coaching a sports team, or any of an infinite range of possible activities. If the activity
requires expertise or skill to perform, then technical writing is a necessary component.
Only a small proportion of technical writing is actually aimed at the general consumer audience. Businesses and organizations deliver vast amounts of technical
writing to explain internal procedures, design and produce products, implement processes, sell products and services to other businesses, or define policies. The
leading professional association representing technical writing, Society for Technical Communication, hosts a number of special interest groups for these different
aspects of the profession.
Technical Writing Categories
Technical writing comprises the largest segment of technical communications. Technical writers work together with editors, graphic designers and illustrators,
document specialists, content managers, instructional designers, trainers, and analysts to produce an amazing variety of deliverables, including:
Contracts Online and embedded help Requirements specifications
Customer Service scripts Policy documents Simulations
Demonstrations Process flows Training course materials
Design documents Project documents User manuals
FAQs (Frequently Asked Questions) Product catalogs Warning labels
How-to videos Product packaging Web-based Training
Instructions Proposals Websites
Knowledge base articles Release notes White papers
Reference guides
Technical writing follows a development lifecycle that often parallels the product development lifecycle of an organization:
Identification of needs, audience(s), and scope
Planning
Research & content development
Testing / review and revision
Delivery / production
Evaluation and feedback
Disposition (revision, archiving, or destruction)
Technical Writing and Integrated Technical Communications
Enormous changes have occurred in the field of technical writing in the last 20 years, particularly with how technical content is researched, and how it is produced
and delivered. As a result, more organizations are developing integrated technical communications to effectively manage the information that must be
communicated. They also build a content management strategy that encompasses delivery of technical, marketing and promotion, internal and other
communications messages between the organization and its customers, suppliers, investors and employees.
Additional Resources
Oxford University Press. (http://oxforddictionaries.com/definition/technical?region=us accessed November 25, 2011).
US Bureau of Labor Statistics, Occupational Outlook Handbook, 2010-2011 (http://www.bls.gov/oco/ocos319.htm, accessed November 3, 2011)
Wikipedia article on technical writing (http://en.wikipedia.org/wiki/Technical_writing, accessed November 25, 2011)
Society of Technical Communications (http://stc.org)
Related Searches
How to Become a Technical Writer
Essential Technical Communications Skills
Technical Writing Terms and Definitions
What is Technical Communications?
Software Tools for Technical Writing
Recommended Next Readings on TechWhirl’s Tech Writer Today
TechWhirl’s Technical Writing Research Portal (Various)
TechWhirl’s Technical Communication Research Portal (Various)
Learn More about Localization (Various)
Tech Writer Tips and Tricks sponsored by Adobe (Various)
Techie Writer Series (Eric Ray)
Integrated Technical Communications (Connie Giordano & Al Martine)
The 5 W’s of Online Help (Geoff Hart)
The Quality of Writing Can Never be Better than the Quality of Research (Herman Holtz)
The New Communications Cycle series (Connie Giordano)

Technical Writing and Documentation

Informal Definition
Firstly, we will explain the underlying working of technical writing. It is a form of communication. Communication refers to the exchange of information, ideas and
thoughts between two or multiple parties via professional documentation. Hence, technical documentation or communication involves the transmission of technical
knowledge about a new technology or product to the non technical users.
Formal Definition
Before we go into the purpose and details of technical writing, have a look at the following definitions:

“Technical writing refers to straightforward explanations and/or instructions dealing with a particular technical subject. The subject being written about may be
abstract or tangible.”

or

“Technical writing, a form of technical communication, is a style of writing used in fields as diverse as computer hardware and software, engineering, chemistry, the
aerospace industry, robotics, finance, consumer electronics, and biotechnology. Technical writers explain technology and related ideas to technical and
nontechnical audiences. This could mean, for example, telling a programmer how to use a software library or telling a consumer how to operate a television remote
control.”

or

“Technical Writing is a term that represents an increasingly broad set of activities that are designed to communicate understandable information that can help
people be productive.”

Gerald J. Alred, being a technical writer, wrote a book named Handbook of Technical Writing where he discussed in detail that technical writing is all about
enabling the readers to understand a new technological theory, concept or a process.
technical writing definition, technical documentation

Extended Definition
Transforming Technical Information into Words
It is the job of a technical writer to translate the hardcore technical information into words which are easy to grasp and follow.
Elements of Consideration
Technical writing includes process flows, user journey and story boards, SDLC documents, FAQs and product walk-throughs. It demands an effective and easy-to-
understand presentation and explanation of complicated workings.

Formats of Technical Documentation

Commonly, technical documentation is produced in the following formats:

Manuals (Product or user): Mostly they are produced in hard copy

PDF Format: PDF files can be distributed int eh form of e-books or soft form handi-material.

Online Wikis: Organizations mostly use restricted wikis for product information for internal communication.

Infographics: These give a pictorial understanding of a concept or workflow.

Presentations: Powepoint, Prezi or Keynote are used to present concepts and finer details.

Nature of Technical Writing

The requirement of technical writing is that the information presented must be precise and to the point therefore, technical writers make use of objective tone rather
than subjective. The technical writing style is strictly utilitarian and emphasizes on clarity, accuracy and corrective-ness, not on elegance and allusiveness like
creative or essay writing.

Importance
Everyday we hear about new inventions in technology; we all need to upgrade our tech knowledge in order to survive in this global world. Thanks to technical
writers who create for us the how-to guides, manuals, textbooks, instructional material and explain to us in simple and meaningful words about the technological
inventions, their purpose and usage.
What Does Technical Writing Include?
Styles and Methods
Technical writing covers a broad range of areas and includes various types of technical writing areas. However, typically it includes the following deliverables:

White papers
User guides and manuals
Application programming interface programmers’ guides
Network configuration guides
Network administrators’ guides
Network recovery guides
Presentations
Site guides /FAQs
Reference documents
Training materials
Installation guides
Alarm-clearing procedures
Troubleshooting guides
Specification documents
Proposals
Reports
Magazine articles
Policies and procedures
Requirement documentation
Certification and Accreditations
Procedure reports
Release notes
Corporate disclaimers
Technical papers
Scientific reports
Hardware maintenance and repair procedures
Conclusion
Therefore, from the above definitions and explanation of technical writing and documentation we can conclude that it is basically a non fiction form of content
creation that relies on information delivery in the most digestible manner. The content and format may vary but the intent is to transform knowledge. Other forms of
writing, closely related with technical writing are expository writing, business writing and academic writing.

DEFINITION OF TECHNICAL WRITING

in Technical Writing /

DEFINITION OF TECHNICAL WRITING

Technical writing is difficult to define. Researchers in the field simply have not agreed on a definition. To help Yolk( though, this section proposes an operational
definition and then explains technical writing’s purposes and characteristics.

An Operational Definition of Technical Writing

Technical uniting is the practical writing that people do as part of their jobs. Whatever their position – from executive to middle manager, from specialized
research scientist to secretary – people generate documents as an expected part of their responsibilities. These documents enable businesses; corporations; and
public agencies, including governmental units, schools, and hospitals, to achieve their goals and maintain their operations. Some documents may be brief a memo
on the progress of a project could be one page long” Other documents are lengthy a report on the feasibility of a certain site for a new plant could be hundreds of
pages long; some military manuals are thousands of pages Regardless of the type of type of produced or its or its length technical writing is a is medium that
transmit the knowledge of people need to full fill their role in origination.

Purposes of Technical Writing

Although technical writing occurs in many places and takes many forms, it has two basic purposes to inform and to persuade Most technical writing informs. To
carry out their functions in the workplace, people must supply or receive information constantly. They need to know or explain the scheduled time for a meeting,
the division’s projected profits, the physical description of a new machine, the steps in a process, the results of and experiment.

Technical writing also persuades. On the job, people must persuade others to follow certain courses of action. A writer not only describes two sites for a factory but
also persuades readers to accept one of them as the best. Another writer describes a problem. in a certain situation – perhaps a bottleneck in a production
process – then persuades readers to simplify the solution he or she proposes. In a slightly different vein, persuading is teaching or instructing ..Someone must tell
consumers how to use their new purchase, whether it is a clock.radio or a mainframe computer.
Someone must tell medical personnel exactly how to react when a patient has a heart attack in a hospital. The documents that achieve these purposes are called
technical writing:

Characteristics of Technical Writing

Technical writing has four common characteristics (Cunningham). It engages a specific audience; uses plain; objective language: stresses clear organization and
uses visual aids.
Specific Audience Technical writing engages a specific audience about a practical matter. The workers who must attend a meeting receive the memo that
announces it. The consumer who must program the VCR receives the manual that explains the process. The executive who must choose between two alternatives
receives the feasibility report that explains them. The reader receives the document because of his or her role in the situation: If the reader has no role in the
situation, he or she neither receives nor searches out the documents Knowing this, good technical always generate documents whose goal is to address the needs
of readers.
Objective Language Technical writing is written in plain, objective language. Since its purpose is to inform or persuade a reader about a specific practical matter,
technical writing focuses the attention on the relevant facts. The reader should respond only to the”‘subject; when ever it is. As much as possible, the words
should not cause the readers to add their own personal interpretations to the. subject. Contrast this kind of writing with writing designed to engage emotions –
poems, novels, plays, and reflective essays. Here is a description. of a death from the novel, A Thief of Time, by Tony Hillerrnan. Notice that the wording is
designed to engage the reader’s feelings, to help the reader feel the sinning finality of death. “There’s no good way to tell you this, Mr. Leap horn,” the voice had
said. “We lost her. Just now. It was a blood clot. Too much infection.

Untitled

Too much strain. But if it’s any consolation, it must have been almost instantaneous.” He could see the man’s face – pink-white skin, bushy blond eyebrows, blue
eyes reflecting the cold light of the surgical waiting room through the
lenses of horn-rimmed glasses, the small, prim mouth speaking to him. He could still hear the. words, loud over the hum of the hospital air conditioner.’ It was like
a remembered nightmare. Vivid. But he could not remember getting into his car in the parking lot, or driving through Gallup to Ship rock, or any of the rest of that
day. He could remember only reviving his thoughts of the days before the operation. Emma’s tumor would be removed. His joy that she was not being destroyed,
as he had dreaded for so long, by the terrible, incurable, inevitable Alzheimer’s disease. It was just a tumor. Probably not malignant. Easily curable. Emma would
soon be herself again, memory restored. Happy. Healthy beautiful.

“The chances?” the surgeon had said. “Very good, Better than ninety percent complete recovery. Unless something goes wrong, an excellent prognosis.”But
something had gone wrong.The tumor and its placement were worse than expected. The operation had taken much longer than expected. Then infection, and the
fatal clot.

Now consider a set of instructions prescribing courses of action in a life-or-death situation – a heart attack in’ a hospital. When a head nurse describes the
procedures to follow in this situation, she chooses words that enable the reader to focus on the actions that will save the victim. She neither wishes nor tries to
engage the subjective emotional dimension of the situation. To accomplish her goal, she states the desired actions and Here is such a set of instructions (“Dr.
Heart” the precise wording that is designed to produce professional, unemotional response.

1. The ICU/CCU-trained RN, or supervisor, shall take charge of arrest situation and designate responsibilities.
2. Record arrest events and treatment on Critical Care Flow Sheet. (Person to be designated by RN in charge.) If extra RN is available, she will critique code by
using the code rating scale (appointment by charge RN).
3. Place the cardiac board under patient when crash cart arrives.
4. Use ambu bag and Elder valve to replace initial mouth-to-mouth ventilation.
5. Connect patient to monitor.
6. Plug in defibrillator and turn on.
7. Start IV with 5% dextrose using largest gauge needle possible and an”addit” IV tubing set.
8. Prepare stlction apparatus for use.
9. Prepare intubation equipment for use when qualified person arrives.
10. Administer IV medications if the physician orders. Administer NaHCO 1 amp
every 5 minutes x 2.
11. When the physician arrives, explain time elapsed and patient condition.

Of course, human beings are not machines, and emotions are part of all, human activity. A nurse working on a heart attack victim might experience a traumatic
emotional reaction, caused perhaps by the victim’s resemblance to someone dose to her. The point, however, is that the set of instructions does not encourage an
emotional, subjective response. The instructions, written in plain, objective language, focus the reader’s attention only on I act of saving a life.

Clear Organization Technical writing is clearly organized, which makes it easier to read and organization clearly, good technical writers employ. and emphasize
words and phrases that point out structure. Since strategies for organizing are discussed fully in Chapter 4, only three will be briefly mentioned here. Technical
writers “set up” a document, they use obvious repetition, and they emphasize transitions at the beginnings of paragraphs and sentences, To “set up” a document
means to follow the old rule, “Tell them what , you’re going to say, then say it.” At the beginning of the document writers’ often name the topic idea and list the
topic’s subdivisions. To use obvious repetition means to repeat key words. To emphasize transitions means to use words that clearly indicate the start of a new
section. Careful writers place words like first, second, or another at the beginning of sentences. Readers respond positively to such devices because the material
is easier to comprehend. The following brief paragraphs use these devices.

SPECIFICATIONS
A specification is a detailed description of the requirements for the design and construction of parts, assemblies, or a complete product. Specifications cart also be
the requirements for a process in manufacturing. A product developer will write three kinds of specifications: testing, processing, and initial fabricating.
Testing specifications are taken from the operating environment in which the part will function. The engineer examines such elements as temperature, pressure,
moisture, time of use, and number of cycles in the service life. Then he or she specifies tests to duplicate the worst possible scenario that the part will be expected
to endure. Processing specifications are the guidelines necessary tor makinglhe part. Processing conditions such as heating, rate of cooling, mold temperature,
injection pressure, and rate of flow are all examples of controls to be specified.Initial fabricating specifications usually come from the blueprints and contain
tolerances tor all declensions. Tolerances are the range from the minimum acceptable size to the maximum acceptable size for all dimensions. Fabricating
.specifications also contain instructions for creating unusual shapes or angles.

Untitled

experiments or projects almost always include tables or graphs. Manuals . and sets of.instructions rely’ heavily on drawings and photographs. Feasibility reports
might even include maps of sites. In addition to the “picture” visual aid, the format of each page helps to convey meaning. Technical writers numbered vertical list
s,various marginal indentations, and white space between lines to emphasize important points or clarify difficult ones. a page from the Mac Write software
program manual (Stanton-Woman and Espionage 50)], uses visual aids and page design effectively to convey its message. The main heading, “Working With
Windows,” is larger than the three subheadings. A set-up list of key terms (“title bar,” “close box,” and so on) occurs ‘in paragraph 2 of the introduction. The type of
the four headings and the four columns is aligned exactly at the top. Vertical lines divide the text into units. In the square boxes, the dashed diagonal lines and the
dotted parallel lines clearly indicate the actions in the text. The three pictures exactly represent the computer screen. All these elements work together to help a
reader easily grasp a complex topic.

SUMMARY
In the workplace, people write often, and the quality of their writing affects their career advancement. Technical writing is the practical writing that people do as part
of their jobs. The most common types of technical writing are memos, letters, and short reports. The most necessary skills are organizing and writing clearly.
Technical writing.

EXERCISES

1. Interview a professional in your field of interest. Choose an instructor whom you know or a person who does not work on campus. Ask questions about the
importance of writing to that person’s job. Questions you might ask include How often do you write each day or week? How important is what you write to the
successful performance of your job? Is writing important to your promotion?What would be a major faulting a piece of writing in your profession? What are the
features of writing (clarity, organization, spelling, etc.) that you look for in someone else’s writing and strive for in your own writing? Write a one-page memo in
which you present your findings. Your instructor may ask you to read your memo to your classmates.

2. Photocopy a one- or two-page selection that you’ consider good technical writing. Use a textbook, an operator’s manual, a technical report you may have seen,
an article from a journal, a sales brochure, or some other document. Write one to three paragraphs to your instructor explaining why the selection is good technical
writing. Refer to the two purposes and four characteristics of technical writing described in this chapter.

3. Photocopy two selections that treat the same subject – one technically, the other emotionally. You can find good contrasts by using poetry and textbooks – for
instance, a poetic description of a bird and a field guide description of the same bird. Write several paragraphs to your instructor comparing the selections and
pointing out the” features that make the technical writing objective and the poetic description emotional.

What is the function of technical writing?

A:
QUICK ANSWER
Technical writing is mainly used to pass on fundamental details of various equipment or technical solutions in a way that is easy to understand for the lay person,
with the goal being to inform decision makers as much as possible. Technical writing is commonly employed within many organizations, ranging from universities
to businesses. CONTINUE READING
KEEP LEARNING
What are the aspects of technical writing?
What are the five basic principles of technical writing?
What are the purposes for technical writing?
FULL ANSWER
Technical writing also needs to be tailored to meet the needs of the specified readership. This can often vary between managerial staff or supervisory staff. Senior
decision making staff will often need to know the costs, benefits and possible difficulties of certain solutions, whereas engineering or technical staff may need to
know more in-depth specifications.
The most fundamental aspect of technical writing is making sure that the report is easy to understand, especially for readers not experienced in the subject area.
This often involves reducing and altering technical jargon as much as possible.
In universities, technical writing is used to communicate across disciplines in many cases, especially in the areas of information technology, applied science and
engineering. Once again, presenting information in a clear, easy to understand format that can easily be digested by non-experts is crucial. Successful technical
writing will always pass on the fundamental points without confusing the reader.
Technical Writing is a form of technical communication. It is a style of writing used in fields as diverse as computer hardware and software, engineering, chemistry,
the aerospace industry, robotics, finance, consumer electronics, and biotechnology.
The Society for Technical Communication (STC) defines technical writing as a broad field that includes 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 by using technology, such as web pages, help files, or social media sites; or (3) providing instructions about how to do something,
regardless of how technical the task is, and regardless of whether technology is used to create or distribute that communication.
Technical writing is accomplished by technical writers, who may be professionals or amateurs. Such writers ideally begin by forming a clear understanding of the
purpose of the document that they will create. Technical writers then typically gather information from existing documentation and from subject matter experts
(SME). An SME is any expert on the topic that the writer is working on. Technical writers are often not SMEs themselves (unless they are writing about creating
good technical documentation). Workers at many levels, and in many different fields, have a role in producing technical communications. A good technical writer
needs strong language and teaching skills and must understand the many conventions of modern technical communications.
Advanced technical writers often move into specialized areas such as API writing, document architecture, or information management.
Contents

1 Overview
2 History
3 Communicating With The Audience
4 Technical Writing Is Presentational
5 Types Of Technical Documents
6 Associations
7 See also
8 External links
9 References
Overview
For technical documents to be useful, readers must be able to understand and employ them without having to decode wordy and ambiguous prose. Good
technical writing clarifies technical jargon, presenting useful information that is clear and easy to understand for the intended audience. Poor technical writing may
increase confusion by creating unnecessary technical jargon, or by failing to explain unavoidable technical terms.
Consider a technical writer writing a cake recipe:
Audience: Is the audience composed of people in home kitchens, or highly trained chefs in professional kitchens?
Source: Is there existing documentation—a rough draft? Who is the subject matter expert (SME)?
Deliverable: Is the deliverable simple text for inclusion in a book, or formatted to final form? Is the target a paper, a web page, or something else?
The three C's of good technical writing are:
Clear
Concise
Complete
Clear, concise, and complete writing helps the reader to grasp the meaning quickly.
The technical writer determines that the recipe is written on the back of a napkin but is partially indecipherable, so he or she must also interview a subject matter
expert (SME)—the chef who created it. On being told that the audience consists of people in their own kitchens, the writer adjusts the writing style accordingly, and
replaces or defines terms such as "beurre mixer" or "springform pan", which may be more suited to an audience of highly trained chefs. The chef reviews a draft of
the recipe (a technical edit) and notates corrections (bake at 350 degrees, not bake at 325 degrees). The writer prepares a final draft, which the document owner
and any other stakeholders review and approve before it is published in one or more formats, such as a paper, or HTML. Different versions of the document might
also be published to meet the needs of different audiences. For example, the version intended for an American audience will use imperial units of measurement,
whereas other versions will use metric measurements. Rather than creating an entirely new document for each audience, the technical writer will create a single
document, and use variables and other methods to manage the differences.

History

The origins of technical writing have been variously attributed to antiquity. However, a clear trend towards the discipline can be seen starting from the time of
World War I, growing out of the need for technology-based documentation in the military, manufacturing, electronics, and aerospace industries. In 1953, two
organizations concerned with improving the practice of technical communication were founded in the United States: the Society of Technical Writers, and the
Association of Technical Writers and Editors. These organizations merged in 1957 to form the Society of Technical Writers and Editors, a predecessor of the
current Society for Technical Communication (STC).
Communicating With The Audience

Audience analysis is a key feature of all technical writing. Technical writing is a communication to convey a particular piece of information to a particular audience
for a particular purpose. It is often an exposition about scientific subjects and technical subjects associated with finance, construction, medicine, agriculture,
technology, and various sciences.
Procedural technical writing translates complex technical concepts and instructions into a series of simple steps that enable users to perform a specific task in a
specific way. To present appropriate information, writers must understand the audience and their goals.
Persuasive technical writing attempts to sell products or change behaviors by putting forth compelling descriptions of how a product or service can be used in
one's life. This type of writing often delves into features and benefits of the product or service, and may use illustrations to make the benefits easier for the
audience to understand.
Technical Writing Is Presentational

Technical writing involves attractive layout for easy reading and comprehension. Presentational strategies help readers to grasp messages quickly.
The top-down strategy (tell them what you will say, then say it)
Headings (like headlines in newspapers)
Chunks (short paragraphs)
Plain, objective style so that readers can easily grasp details.
It is also important to understand the medium typically used to view the final product. An HTML document (web page), viewed through a browser, has
presentational possibilities that are different from those of the printed page, notably hyperlinks and animation, which can enhance the readers' experience.[1]

Types Of Technical Documents

Technical writers use computers and other electronic communications equipment extensively in performing their work. They also work regularly with publishing
software and various authoring environments to prepare material directly for the Internet. Technical writers frequently work with word processing, graphic design,
page layout, and multimedia software. The nature of technical writing is evolving, and modern technical writers combine text, graphics, images, and sound into
their work.
Broadly speaking, technical documentation can be categorized into three types, depending on the style of writing, the level of knowledge transferred, and the
target audience:
End-user assistance. These information products help a user understand how to use a technical software or hardware product. User manuals for computer
software, hardware, household products, medical equipment, cell phones, smartphones, and other consumer electronics belong to this category.
Traditional technical documentation. Here the writer's objective is to communicate to a specific audience. Maintenance guides, appliance or application repair
manuals, engineering specifications, research papers, reference works, annual reports. and articles written for technical journals (to name a few examples) belong
in this category.
Marketing communication. Product catalogs, brochures, advertisements, introductory pages for web sites, press releases, and advertising copy belong in this
category.
Technical writing is often associated with online help and user manuals. They also create product release notes, product troubleshooting guides, product user
guides, tutorials (textual and multimedia), installation guides, API programmers' guides, marketing documentation, E-learning modules, web content, legal
disclaimers, policies and procedures, business proposals, and white papers, among others. Technical design and Technical Drawing are also considered forms of
technical communication.
Associations

Society for Technical Communication

IEEE Professional Communication Society
SIGDOC Special Interest Group on Design of Communication
Institute of Scientific and Technical Communicators (UK-based)
Association for Business Communication
Czech Society for Technical Communication (Cz-based)
Tekom Professional organization for technical communication, Germany
See also

Editing
Instructional design
Creative nonfiction
Introduced error
External links

Technical writing at the Open Directory Project

BLS occupational description for technical writers
EServer Technical Communication (and Technical Writing) Library
IEEE Transactions on Professional Communication
Wikiversity Technical Writing Courses
References

^ What is technical writing: http://www.writewire.co.uk/CONTENT-1900-WHAT-IS-TECHNICAL-WRITING

Categories:
Technical communication
image: http://www.yourdictionary.com/index.php/image/articles/19046.ThinkstockPhotos-128019107.jpg

Technical writing refers to a type of writing where the author outlines the details and operations of administrative, technical, mechanical, or scientific systems. The
main goal of technical writing is to educate, direct, and give others the ability to use a certain system.

Types of Technical Writing

There are three main types of technical writing:

End-user documentation: This type of writing includes documents where the writer explains a topic to a novice so that they can understand technical terms and
apply them in a real-life situation.
Traditional technical writing: This is writing that is geared to an audience already at least somewhat familiar with a technical field such as engineering or politics.
Technological marketing communications: This is writing used in promotional marketing such as fliers and promotional brochures that would entice a person to
purchase a certain product or service.
Examples of technical writing can be found in each of these different types of technical writing.

Uses for Technical Writing

End-User Documentation
Examples of end-user documentation might include:

"Blackberry for Dummies" - that teaches you how to use your new cellular phone and that is written in order to cater to someone who has never before used a cell
phone or who is not a cell phone expert
A manual that comes with a computer
A manual that comes with a video game system, such as the PS3 users guide
Traditional Technical Writing
Examples of traditional technical writing might include:

A whitepaper published in an engineering journal about a new system that has been devised
An article published in a law review that caters to lawyers
An article in a medical journal summarizing an experiment that has been conducted and written to a medical audience. For example, articles published in the New
England Journal of Medicine would fall into this category
Technical Marketing Communication
These might include:

A promotional ad outlining why you would want to purchase a new computer and explaining the features of that computer
A promotional ad explaining why you would want to purchase a new cell phone, outlining the phone's features
A promotional ad explaining why you would want to purchase a new mp3 player and outlining the phone's features, such as an ad for the Creative Zen Mozaic
Mp3 player
Successful Technical Writing
When carrying out a technical writing assignment, you must remember to follow what is known as the three ‘Cs’ and ask yourself the following questions:

Is it clear?
Is it concise?
Is it complete?
Because technical writing is so often aimed towards those who may be unfamiliar with technical jargon and terminology, it is important that a technical writer uses
clear and unambiguous language in their assigned piece.

If the writing is too full of technical language, the message may not come across as intended.
If the information being written about is provided in a convoluted and round-about way, the message is likely to be lost entirely. Straight forward and to the point is
always best.
If a technical writer’s information is incomplete, it inhibits the audience’s understanding of the topic and can, in some cases such as instruction and safety manuals,
prove dangerous.

Above all, technical writing needs to be very clear and concise to be successful.
Read more at http://examples.yourdictionary.com/technical-writing-examples.html#BrpZmUtrkYUkkmUY.99

Technical Writing Examples in Three Major Categories

OCTOBER 11, 2013 BY JOE LOWMILLER
technicalwritingexamplesThe field of technical writing offers a lucrative career opportunity for those who are skilled in communications. Individuals enter the
profession from different backgrounds and for different reasons. Some have pursued a career in writing and found a knack for communicating complex material.
Others have held technical positions and made the transition into writing specifically about their areas of expertise.

What all of these professionals have in common is the ability to write about technical information in a way that their intended audience can understand and use
easily. It’s a unique skill set, and one that you can learn to develop if you are considering entering the field. A good place to start is a brief online course introducing
technical writing and covering the fundamentals of the discipline. If you would like to take a deeper dive, you can also find a comprehensive online course on
technical writing and editing.

To give you a picture of the kinds of materials technical writers typically produce, here are some examples and some specific considerations for each:

End-user documentation

Many products require written explanations and instructions in order for users to understand and operate them effectively. In fact, these can be such an important
element of the final package that they are often considered part of the product itself. After all, what good is a feature of a software program if you don’t know how
to use it? And how do you compare that software next to one that does a better job explaining the available features?

It is critical for a technical writer working in this area to write as clearly and concisely as possible, using layman’s terms and defining any required technical
terminology. If you need some polish to write with a good, easily understandable style, you might benefit from a course in writing quality paragraphs and essays to
get started. The output for a given product can take a variety of forms, including the following:

Product manuals
Often, a product will come packaged with hard-copy documentation explaining its features in detail. Increasingly, for complex products, such as software, these are
becoming more rare. Instead of including in depth material, software will often include a slim guide to get users up an running. The more in depth material will then
be left for third-party experts publishing on the subject or user help tools available either in the software or online.

Assembly guides

Technical writing includes step-by-step assembly instructions, which need to be carefully crafted to ensure that the end-user can complete the steps safely and
accurately.

Quickstart guides

As mentioned in reference to software, products sometimes include a brief introductory guide to get a user started on working with its features. These documents
do not include comprehensive information covering all elements. Instead they focus on clear and concise directions for getting the user started. These are
sometimes included in addition to a more comprehensive user manual, a practice commonly seen with cell phones and smart phones.

User help functions

Much of technical writing for end-user software documentation takes place electronically. Technical writers build interactive guides where users can look for
information specifically related to a question they have about a product. This helps them troubleshoot as they encounter obstacles in using the software. It also
gives them the option of reading through the guide for a more comprehensive understanding.

Technical books

Again, often related to software products, and with certain kinds of hardware, third-party authors often write full length guides to help users thoroughly learn the ins
and outs. If this is a goal for you as you set out into the technical writing field, you might get a headstart in a course on writing a how-to book.
Traditional technical writing

In the case of product documentation, the writing goal is most often to inform a non-expert audience. The dynamic is very different in traditional technical writing. In
this situation, the technical writer is creating content for an audience of experts. Here are some examples of deliverables in this category:

Scientific and medical papers

Practicing research scientists and medical researchers often work with technical writers to complete write-ups on their studies, which will ultimately be published in
journals. Other practitioners will review this information to understand the latest findings and procedures, so the material needs to reinforce the credibility of the
research and accurately reflect the details of the work.

Reviews and reports

Outside of the scientific community, technical writers work in and number of fields to communicate between professionals. This can include, for instance, legal
case reviews, technical diagrams and schematics, and sometimes correspondence related to technical material (briefings, memos, etc.)

Marketing content of a technical nature

While the field may sound as though its material is as objective as possible and strictly for informing audiences, technical writers also engage in persuasive content
development, often working in connection with marketing and sales teams. To persuade, after all, content often needs to be precise and credible, so technical
writing easily fits in.

If you need to work on the persuasive elements of your writing, you can take an online course that will teach you to enhance your techniques in persuasion.
Meanwhile, here are some examples of writing you might take on within this category:

White papers
A long-form marketing project, white papers are designed to thoroughly investigate a topic that presents a problem for a specific audience. These reports will
recommend a solution that highlights a company’s products.

Case studies

Technical writers are often involved in expounding on details of a specific account and how they successfully met a business goal or overcame a challenge
working with a company’s product.

Brochures

Often, technical writers are called on for product brochures or online descriptions that go in to a deeper level of detail about how a product functions.

Proposals

Many business to business sales efforts involve a formal proposal process wherein the proposer must draw out plans and specifications for a solution in detail.
Technical writers often work as part of a team to handle the more technical aspects of this writing.

As you can see, the field of technical writing is broad and diverse. There are many opportunities within it for a writer who is good at working with complex
information. Explore these examples and other options available, and find the area of technical writing that is best for you.

Description of Mechanism
A mechanism is generally defined as any object or system that has a working part or parts. Most often the term suggests tools, instruments, and machines. But
other examples of mechanisms could be the human body and systems like the universe or a city, which is composed of parts that work together like parts of a
machine. A technical man constantly works with mechanisms and always needs to understand them; what they do, what they look like, what parts they have, and
how these parts work together.
There are three fundamental divisions of the description and these are the introduction, the part-by-part description, and the conclusion.
Because the description of a mechanism seldom constitutes an article or report by itself, the introduction required is usually rather simple. The two elements that
need most careful attention are:
1. the initial presentation of the mechanism
2. the organization of the description

The Initial Presentation

At the beginning of a discussion of an unfamiliar mechanism, a reader immediately needs three kinds of information: what it is, what its purpose is, and what it
looks like.

Organization of the description. It is possible to divide almost every mechanism into parts. In the initial presentation of the description, the purpose indicates the
organization of the discussion that is to follow. Since it is logical to describe the principal parts one at a time, a list of the principal parts in the order in which one
wishes to discuss them is a clear indication of the organization of the remainder of the description. The order in which the parts are taken up will normally be
determined by either their physical arrangement or their function.

The list of the principal parts should be in parallel form.

The parts are usually named in normal sentence form, like,

“The principal parts of the lathe are (1) the bed, (2) the headstock, (3) the tailstock, and (4) the carriage.” But if the parts are numerous, it may be preferable to
present them in the form of a list.

Part-by-Part Description
After the introduction and the mechanism logically divided into parts, the description of the first part follows. But the fact is that now, as far as method goes, it is
almost as if one had not written a line. The part that is to be discussed is a brand new mechanism. The reader wants to know what it is. So again, it has to be
introduced.
The lathe machine has been divided into the bed, the headstock, the tailstock and the carriage and now we are about to describe the bed. The first problem is to
tell the reader what the bed is. The general procedure will be – as before – to define the part, to state its purpose, to indicate its general appearance, and finally, if
necessary, to divide it into subparts.
What is done to the principal parts is also done to the subparts. In other words, the mechanism as a whole is progressively broken down into smaller and smaller
units until common sense says it is time to stop. Then, each of these units is described in detail. The value of this system is for general policy, it is simply not true
that all description should be handled in this way. Sometimes, for example, instead of giving a preliminary statement of all the subparts that will be described in a
given section of the description, it is desirable not to mention a certain minor subpart at all except when it is actually described.
Aspects of the mechanism that needs careful attention when describing in detail a subpart of the mechanism:

Shape
Size
Relationship to other parts
Methods of attachment
Material
Finish

Each of these matters need not be labored over mechanically, in the order stated, in every description. Which one needs attention, and what kind of attention,
depends upon the reader and the subject. The same line of reasoning can be applied throughout the description. There is no formula that will fit every situation.
The important thing is to decide what information the reader needs, and to provide it as clearly as possible.

Conclusion of the Description

The last principal function of the description of a mechanism is to let the reader know how it works, or how it is used, if this has not been done in the general
introduction. Emphasis should naturally fall upon the action of the parts in relation to one another. This part of the writing constitutes in effect a description of a
process usually highly condensed, and this will be discussed elaborately in the next technique of development.

Summary of the Principles of Organization

Description of a Mechanism
I. Introduction
A. What the mechanism is
B. Purpose
C. General appearance
D. Division into principal parts II. Part-by-part description
A. Part number 1
1. What the part is
2. Purpose
3. Appearance
4. Division into subparts
a. Subpart number 1
(1) What the subpart is
(2) Purpose
(3) Appearance
(4) Detailed description
(a) Shape
(b) Size
(c) Relationship to other parts
(d) Methods of attachment
(e) Material
(f) Finish
b, c, etc.- same as “a”
B, C, etc. – same as “A”