Introduction
What is technical writing?
Main goals of a Technical writer
Skills Required for a Technical Writer
Abilities Required for a Technical Writer
Job Activities for Technical Writer
Tools used for the Documentation
Introduction
Technical Writing aspects come under the development sector in an IT Industry, Each and every product in an IT Industry Documentation play a vital role. Documentation is filling the gap between the end user and the product.
What is technical writing?
As the name indicates writing a Technical concept about a particular product with simple and smart English in a structured manner with the help of proper tool is known as Technical Writing.
Main goals of a Technical writer
Audience
Before Entering in to the Documentation , Technical Writer should have some better idea about the type of audience whether the technical or a non technical , after analyzing the type of audience he should put himself in the end user shoe’s and realize the expectation of them.
Readability
Documentation must be prepared with simple communication in properly organized manner such that it should attract the end user to read it.
Look and Feel
Look and Feel aspect can be achieved by using the following terms
Short sentences
Table of Content
Diagrammatical Representation
Some additional features depending up on the Requirement
Skills Required for a Technical Writer
Some of the basic skills that is required for the Technical Writers are as follows
Writing
Communicating effectively in writing as appropriate for the needs of the audience.
Reading Comprehension
Understanding written sentences and paragraphs in work related documents.
Active Learning
Understanding the implications of new information for both current and future problem-solving and decision-making.
Speaking
Talking to others to convey information effectively.
Active Listening
Giving full attention to what other people are saying, talking time to understand the points being made, asking questions as appropriate, and not interrupting at inappropriate times.
Critical Thinking
Using logic and reasoning to identify the strengths and weakness of alternative solutions, conclusions or approaches to problems.
Monitoring
Monitoring or Accessing performance of yourself , other individuals, or organizations to make improvements or take corrective action.
Time Management
Managing one’s own time and the time of others.
Complex Problem Solving
Identifying complex problems and reviewing related information to develop and evaluate options and implement solutions.
Learning Stratergies
Selecting and using training/instructional methods and procedures appropriate for the situations when learning or teaching new things.
Abilities Required for a Technical Writer
Written Expression
The ability to communicate information and ideas in writing so others will understand
Written Comprehension
The ability to read and understand information and ideas presented in writing.
Near Vision
The ability to see details at close range (within a few feet of the observer).
Information Ordering
The ability to arrange things or actions in a certain order or pattern according to a specific rule or set of rules.
Originality
The ability to come up with unusual or clever ideas about a given topic or situation, or to develop creatice ways to solve a problem.
Job Activities for Technical Writer
Getting Information
Observing, receiving, and otherwise obtaining information from all relevant sources.
Interpreting the Meaning of Information for others
Translating or explaining what information means and how it can be used.
Documenting/Recording Information
Entering, transcribing, recording, storing, or maintaining information in written or electronic/magnetic form.
Communicating with Supervisors, Peers, or Subordinates
Providing information to supervisors, co-workers, and subordinates by telephone, in written form, e-mail, or in person.
Drafting, Laying Out , and Specifying Technical Devices, Parts , and Equipment
Providing documentation, detailed instructions, drawing, or specifications to tell others about how devices, parts, equipment, or structures are to be fabricated, constructed, assembled, modified, maintained, or used.
Processing Information
Compiling, coding, categorizing, calculating, tabulating, auditing, or verifying information or data.
Monitor Process , Materials , or Surroundings
Monitoring and reviewing information from materials, events, or the environment, to detect or assess problems.
Updating and Using Relevant Knowledge
Keeping up-to-date technically and applying new knowledge to your job.
Identifying Objects, Actions, and Events
Identifying information by categorizing, estimating recognizing differences or similarities, and detecting changes in circumstances or events.
Thinking Creativily
Developing, designing, or creating new applications, ideas, relationships, systems, or products, including artistic contributions.
Tools used for the Documentation
Some of the basic tool that are used for the documentation are as follows
- Robo-Help
- MS-Word
- MS-Paint
- Frame Maker
- Visio
- Snag-IT
- Author-IT
- Robo-HTML
|