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 Documentation?

Technical communication is the process of conveying information about technology to an intended audience.

A technical document is a writing that contains information.

Traditionally, the medium of a document was paper and the information was applied to it as ink either by hand (to make a hand-written document) or by a mechanical process (such as a printing press or a laser printer).

Understanding Technical Documentation?

Through time, documents have also been written with ink on papyrus (starting in ancient Egypt) or parchment, scratched as runes on stone using a sharp apparatus, stamped or cut into clay and baked to make clay tablets (i.e. in Sumerian and Mesopotamic civilisations).

Paper, papyrus or parchment might be rolled up as scrolls or cut into sheets and bound into books. Stacks of clay tablets might also be thought of as books. Small documents might also be stapled.

Definitions of Technical Documentation?

Today, electronic means for storing and displaying documents are also popular; a variety of computers and displays can be used, for example:

  • a desktop computer with a monitor
  • a laptop
  • a Personal Digital Assistant
  • refreshable electronic paper

Documents in all forms are frequently found to be material evidence in criminal and civil proceedings. The forensic analysis of such a document falls under the scope of questioned document examination.

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.

"Technical writing is the presentation of information that helps the reader solve a particular problem. Technical communicators write, design, and/or edit proposals, manuals, web pages, lab reports, newsletters, and many other kinds of professional documents.¡±

It is interesting to note that outside the U.S. the definition of technical writing tends to stay very consistent. A [U.K.-based firm] persists that ¡°technical writing is the presentation of information on any scientific, engineering, or technological topic in the form most suited to its user.¡±

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

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 ^^^