Technical Commu Report
Technical Commu Report
Technical Commu Report
CONTENT CREATION:
Technical communication is sometimes considered a professional task for
which organizations either hire specialized employees, or outsource their
needs to communication firms. For example, a professional writer may work
with a company to produce a user manual. Other times, technical
communication is regarded as a responsibility that technical professionals
employ on a daily basis as they work to convey technical information to co-
workers and clients. For example, a computer scientist may need to provide
software documentation to fellow programmers or clients.
1
The technical writing process can be divided into five steps:
2
for ease of searching, for example by the frequent inclusion of headers,
white space and other cues that guide attention. Other requirements will vary
on the needs of the particular audience.
• Purpose
• Needed information
• Educational Background
With this information, important needs can be satisfied in a way that caters
to all. If this is not possible, audiences may be prioritized by importance, and
serving important audiences first. Remaining audiences can be served by
including clearly denoted content within the text, such as the advanced topic
sidebars that frequently occur in user's guides.
Collecting Information:
The next step is to collect information needed for accomplishing the stated
purpose. Information may be collected via primary research, where the
technical communicator conducts research first-hand, and secondary
research, where work published by another person is used as an information
source. The technical communicator must acknowledge all sources used to
produce his or her work. To ensure that this is done, the technical
communicator should distinguish quotations, paraphrases, and summaries
when taking notes.
Once each idea is organized, the writer can then organize the document as a
whole. This can be accomplished in various ways:
3
• Chronological: This is used for documents that involve a linear
process, such as a step-by-step guide describing how to accomplish
something.
• Parts of an object: Used for documents which describe the parts of an
object, such as a graphic showing the parts of a computer (keyboard,
monitor, mouse, etc)
• Simple to Complex (or vice versa): Starts with the easy to understand
ideas, and gradually goes more in-depth with complex ideas.
• Specific to General: Starts with many ideas, and then organizes the
ideas into sub-categories
• General to Specific: Starts with a few categories of ideas, and then
goes more in-depth.
Once the whole document is organized, it's a good idea to create a final
outline, which will show all the ideas in an easy to understand document.
Creating an outline makes the entire writing process much easier and will
save the author time.
4
• Edit for style:
Style refers to changes that make the writing more interesting, appealing, or
more readable. Some changes are made by choice, not for correctness, and
may include:
• shorten paragraphs
• rearrange paragraphs
• change passive-voice sentences to an active voice
• shorten sentences
• add headings, lists, graphics
Controlled languages:
In environments where readability and (automated) translatability are of
primary concern, authors may be using a controlled language, i.e. a subset of
natural languages whose grammars and dictionaries have been restricted. An
example of a widely used controlled language is Simplified English, which
was originally developed for aerospace industry maintenance manuals.
5
• User interface designer
• Technical trainer
TECHNICAL WRITER:
Technical writers are professional writers who design, create, maintain and
update many types of technical documentation, online help, user guides,
white papers, design specifications, and other documents. Sometimes, a field
engineer may need to be a technical writer, as well.
Their given field can be almost anything that requires specialized knowledge
and information
Qualifications:
Technical writers normally possess a mix of technical and language abilities,
and have degrees or certifications in areas such as Computer Science,
Electrical Engineering, Telecommunications, Technical Communications,
Journalism, Communications, English (or the applicable language), and
Management. The writer should have enough expertise to understand the
document's intended readers.
A good technical writer has the ability to assimilate and convey technical
material in a concise, effective manner. It is more difficult to find technical
6
writers with command of technical areas, so those writers are generally in
higher demand. For example, writers who develop documentation for
development software, microcontroller operations, and other technical
subjects often have better prospects than those who write user guides for a
less technical audience (for example, "How to use email"). Writers with
experience in multiple technical areas have an even greater advantage.
Technical writers are known in the United Kingdom and some other
countries as technical authors or Knowledge Authors. Technical
writers may also be known by other names such as Technical
Communicators and Technical Documentation Specialists.
Methodology:
Instructional or how-to documents are written in the present tense using the
second person (you). Technical writers avoid the use of passive voice.
7
Environment:
Technical writers often work as part of a writing team. In most cases, after
the documentation is written, it's reviewed for content accuracy and
completeness by one or more "Subject Matter Experts" (SME’S), at a
minimum. Others, such as users or managers, may review it to ensure it
suffices from a more practical or high-level perspective (such as review of
administrative errors and organizational problems). Finally, it should be
edited for spelling and reviewed for correct and proper grammar and usage
(generally by a native speaker of the language of the document)
EDITING:
Editing is the process of preparing language, images, or sound for
presentation through correction, condensation, organization, and other
modifications. A person who edits is called an editor. An important part of
editing is the idea conception angle, and having the judgment to assign who
does the work. Editing is therefore also a modality that applies human
relations and creative skills as well. In a sense, the editing process originates
with the idea for the work itself, and in the relationship between the author
and the editor.
Print media:
There are various levels of editorial positions in publishing. Typically one
finds junior editorial assistants reporting to the senior level editorial
managers and directors, who themselves report to senior executive editors
responsible for project development to final releases. Human editors in the
print publishing industry include people who are responsible for:
8
• Organizing and publishing a magazine. The top editor may be called
editor-in-chief.
• Newspaper
• Those who get the magazine into the hands of readers and
subscribers, even, have editorial titles and are called circulation
editors.
• Frequent and esteemed contributors to a magazine may acquire the
title editor at-large or the less pompous contributing editor.
• Producing a definitive edition of a classic author's works—a
scholarly editor.
• Organizing and managing contributions to a multi-author book —
symposium editor or volume editor.
• Finding marketable ideas and presenting them to appropriate authors
— a sponsoring editor.
• Obtaining copy or recruiting authors — such as the acquisitions
editor or commissioning editor for a publishing house.
• Correcting spelling, grammar, and matters of house style—a
copyeditor. But copy editors at newspapers usually also have greater
and higher responsibilities
• Choosing the layout of the publication and communicating with the
printer — a production editor.
The smaller the publication, the more these roles run together. In particular,
the substantive editor and copy editor often overlap: Fact-checking and
rewriting can be the responsibility of either.
Executive editor:
The top editor sometimes has the title executive editor or editor-in-chief (the
former is replacing the latter in the language). This person is generally
responsible for the content of the publication. The exception is that
newspapers that are large enough usually have a separate editor for the
editorials and opinion pages in order to have a complete separation of its
news reporting and its editorial content.
9
The executive editor sets the publication standards for performance, as well
as for motivating and developing the staff. The executive editor is also
responsible for developing and maintaining the publication budget. In
concert with the publisher and the operating committee, the executive editor
is responsible for strategic and operational planning.
Newspapers:
Editors at newspapers supervise journalists and improve their work.
Newspaper editing encompasses a variety of titles and functions. These
include:
• Copy editors
• Department editors
• Managing editors and assistant or deputy managing editors (the
managing editor is often second in line after the top editor)
• News editors, who oversee the news desks
• Photo or picture editors
• Section editors and their assistants, such as for business, features, and
sports e.t.c.
The term city editor is used differently in North America, where it refers to
the editor responsible for the news coverage of a newspaper's local
circulation area (also sometimes called metro editor), and in the United
Kingdom.
10
editor or production editor, who sees the copy through its stages from
manuscript through bound book and usually assumes most of the budget and
schedule responsibilities, and the copy editor or manuscript editor, who
performs the tasks of readying the copy for conversion into printed form.
Technical editing:
Technical editing involves reviewing text written on a technical topic, and
identifying errors related to the use of language in general or adherence to a
specific style guide.
It helps if the technical editor is familiar with the subject being edited, but
that is not always essential. The "technical" knowledge that an editor gains
over time while working on a particular product or technology does give the
editor an edge over another who has just started editing content related to
that product or technology. In the long run, however, the skills that really
matter are attention to detail, the ability to sustain focus while working
through lengthy pieces of text on complex topics, tact in dealing with
writers, and excellent communication skills.
ILLUSTRATOR:
An illustrator is a graphic artist who specializes in enhancing writing by
providing a visual representation that corresponds to the content of the
associated text. The illustration may be intended to clarify complicated
concepts or objects that are difficult to describe textually, or the illustration
11
may be intended for entertainment, as in greeting cards, or cover art or
interior art for books and magazines, or for advertisement, as on posters.
Most contemporary illustrators make their living creating artwork for use in
children's books, advertising, newspapers and magazines. Pen and ink and
airbrush artists traditionally dominated this realm.
Computers dramatically changed the industry, and today computers are used
to produce most of the commercial illustrations.
INFORMATION ARCHITECTURE:
Information architecture (IA) is the science of expressing a model or
concept for information. Information architecture is used in library systems,
web development, user interactions, database development, programming,
technical writing, enterprise architecture, critical system software design and
other activities that require expressions of complex systems.
12
USABILITY:
Usability is a term used to denote the ease with which people can employ a
particular tool or other human-made object in order to achieve a particular
goal. Usability can also refer to the methods of measuring usability and the
study of the principles behind an object's perceived efficiency or elegance.
Usability considerations:
Usability includes considerations such as:
• Who are the users, what do they know, and what can they learn?
• What do users want or need to do?
• What is the general background of the users?
• What is the context in which the user is working?
• What has to be left to the machine? What to the user?
13
Answers to these can be obtained by conducting user and task analysis at the
start of the project.
User interface:
The user interface (or Human Machine Interface) is the aggregate of means
by which people (the users) interact with a particular machine, device,
computer program or other complex tool (the system). The user interface
provides means of:
TRAINER “BUSINESS”:
Trainers work in many different areas, mainly educating employees of
companies on specific topics of workplace importance. Some trainers are in-
house, and others work for training companies.
Many times people confuse the term training facilitator and trainer. As
opposed to the facilitator the trainer does take an active role and transmits
mainly knowledge.
14
POWER TOOLS FOR
TECHNICAL COMMUNICATION:
Technical communicators use a variety of tools to create usable
information. Often referred to as a "tool set", there is no defined list of
tools that are used by all technical writers. However, broad categories of
tools are used by most technical writers and communicators.
WORD PROCESSORS:
There are a variety of word processors available. The most common is Word
by Microsoft. OpenOffice.org is a relatively recent tool that is growing in
popularity.
E-LEARNING PROGRAMS:
The latest trend in online education is to connect tutors and students from
across the world with interactive software. Author LIVE has gained good
ground in the field, offering an excellent tutoring environment, and is fast
becoming the preferred connectivity solution for distance learning. Other
options include IBIS, Blackboard, and Web C T.
15
GRAPHICS PROGRAMS:
There is an old cliché; "A picture is worth a thousand words". This holds
true for technical communication. Many document sets contain large
numbers of screen captures, black-box diagrams, and other explanatory
pictures to assist the reader in understanding a concept or action. The most
commonly used programs are industry leader Corel Photo XI, Photoshop by
Adobe Systems.
16
TEXT EDITORS:
Lightweight text editors are very useful tools. While many word processors
can be used to edit text, specialized text editors generally have features for
handling text that word processors don't have. The most common text editors
are Notepad by Microsoft, BBEdit, vim, and Text pad.
HTML EDITORS:
Any text editor can be used as a HTML editor, but specialized HTML
editors generally include features for manipulating HTML that text editors
don't include. Many word processors can save information as HTML, but the
quality of HTML output is often not to W3C standards. The most common
HTML editors are HTML-Kit, Home site/ Dream weaver, Adobe Go Live.
17
ONLINE FORUMS:
Technical communicators often seek the advice and recommendations of
their peers through online forums. These can include, but are not limited to,
email lists, Wiki pages, and internet forums or discussion boards. The
forums provide information on technical communication standards and job
prospects, as well as several other topics.
CONCLUSION:
By this report I have Understand the Communicator's Work that how they
use their tools and how they apply the Techniques to complete the document
and product and how they make their communication complete and
effective.
As we move into the 21st century, broader approaches in governments,
business, industries, and universities are necessary. Governments are
increasingly forced to collaborate with other governments to address
problems beyond the control of individual nations. Industries increasingly
find it difficult to survive without pursuing global markets. Also, universities
are moving from departmental to interdisciplinary approaches to
curriculums. These changes call for greater scope in goals, social structures,
and methodologies. Technical communication is an example of a field
deeply involved in all of these institutions and prompted toward greater
scope in the engagement of problems. Technical communicators have
learned a great deal about how to design an effective online help system.
18