New Page 3

Klariti Home Page

Download Templates Online

About Us Free Tools Tips Templates Affiliates Site Map

MS Word template

4  x User Guide Templates - Instant Download
Download Now!


What is Technical Writing?

A technical writer is a person who creates documentation for a technology.

They are responsible for writing text that is accurate, readable, accessible, and helpful to its intended audience.

Technical writing, a subset of technical communication, is used in fields as diverse as chemistry, the aerospace industry, robotics, consumer electronic products such as VCRs or digital cameras, biotechnology, software, computer hardware, and many others.

Technical Writing Skills

Technical writers often have a degree in English, technical writing, the technical field for which they are writing, or a combination of these.

It is most important that they have enough expertise to understand their audience's background and needs.

For example, writers who develop documentation for software APIs, microcontroller operation, and other technical subjects are often paid more than those who write guides for a nontechnical audience (for example, how to use email), because it is difficult to find good writers with advanced technical knowledge.

Desktop publishing tools

After the documentation is written, using a desktop publishing tool or a help authoring tool, it is normally reviewed for accuracy by one or more "subject matter experts" (SMEs).

Technical Communication

Technical communication is the process of conveying information about technology to an intended audience. A technical communicator is a person whose job involves technical communication. Technical communication jobs include the following:

  • Technical writer
  • Technical editor
  • Information architect
  • Usability expert
  • User interface designer
  • Technical artist
  • Technical trainer

The technology can be of any kind, including the sciences, high technology including computers and software, consumer electronics, and so on.

Role of Technical Writing

Technical communications are created and distributed by most employees in service organizations today, especially by professional staff and management.

Writing well is difficult and time-consuming, and writing in a technical way and about technical subjects compounds the difficulties. The entire point of communications is to disseminate useful information. To be useful, information must be understood and acted upon.

Effective communications require quality content, language, format, and more. The entire point of communications is to disseminate information; this is where written content comes in. To present the appropriate content, it is imperative to understand ones audience and writing purpose.

If a document does not communicate the information that the writer intends and what he or she wants the reader to understand, then the communication is meaningless.

The writer has a self-interest in making the extra effort: Looking credible is as important as being credible and getting results in business. Respect and credibility of the writer/speaker are integral to effective communications. Readers will not trust the information from an author if they do not believe that author is a valuable source of information or the purveyor of worthwhile ideas. Furthermore, being respected is essential to being persuasive, a key ingredient in business.

This article is licensed under the GNU Free Documentation License. It uses material from the Wikipedia article Desktop Publishing.

Your Thoughts?

What are your thoughts on this? Drop me a line at ivan at klariti dot com


Biz Templates: Proposal Template  Project Management  Employee Handbook  Procedures Business Case Process Design

IT Templates: Software Development  Testing Templates  Training Plan  User Guide Change Management Plan

Sales Templates: White Paper Case Study Business Plan Marketing Plan Cost Benefit Analysis Action Plan

$ 9.99: Acceptance Test Plan  Design Document  Requirements  Test Plan  Feasibility Study Risk Management Plan


Ads

Follow me on Twitter  Facebook  YouTube

T e m p l a t e   S h o p


Software Development Templates

T e m p l a t e   S h o p

Acceptance Test Plan

Acquisition Plan

Action Plan

Audience Analysis

Availability Plan

Bill of Materials Template

Business Case

Business Continuity Plan

Business Plan

Business Process Design

Business Requirements

Business Rules

Capacity Plan

Case Study Templates

Change Management Plan

Communication Plan

Concept Proposal

Configuration Management Plan

Conversion Plan

Concept of Operations

Cost Benefit Analysis

Data Sheet Template

Database Design Document

Deployment Plan

Design Document

Disaster Recovery

Documentation Plan

Employee Handbook

Error Message Guide

Expression of Interest

Fact Sheet Template

Feasibility Study

FAQ Template

Functional Requirements

Grant Template

Installation Plan

Interface Control Document

Invitation To Tender

Maintenance Plan

Marketing Plan

Needs Statement

Operations Guide

Policy Manual

Project Management

Project Plan

Proposal Template

Proposal Forms and Checklists

Request For Proposal

Release Notes

Risk Management Plan

Service Level Agreement

Setup Guide

Statement of Work

Software Development Templates

Software Testing (QA) Templates

Software Requirements Specification

Standard Operating Procedure

System Admin Guide

System Boundary Document

System Design

System Specifications

Security Plan

Test Plan

Technical Writing Templates

Training Plan

Transition Plan

User Guide Template

Use Case Templates

Verification Plan

White Paper Templates

How to Write

Business Documents

Case Studies

Grants Applications

Process Design

Proposals and RFPs

Project Management

Technical Documents & FrameMaker

White Papers

Writing for the Web

Business Process Templates
Project Management Templates

Standard Operating Procedures

Employee Handbook

Policy Manual

Grant Proposal

Training Plan

Statement of Work

Sponsors
 

 



Forms, Checklists, & Templates - Updated Daily

I'm Ivan Walsh, the person behind this site. I help people improve how they write, publish and extend their business assets.

You can email me here or connect with me at Twitter @ivanwalsh, Disqus, Facebook, LinkedIn, Delicious & Google.

Endorsements | About Us | Contact Us | Site Map | Privacy| License | T&Cs | FAQs | Klariti

^^^ Return to top of page ^^^