The Technical Writing Concepts

Introduction

What is Technical Writing?

Technical Writing is a unique style of writing documents in diverse fields of information technology. It follows a simple template to create each type of document with straightforward and uncomplicated language.

The major skills of technical writing include

Simple Language
Gathering Information
Exploring Learning
Proper Planning
Orderly Narration

The ultimate aim of a perfect technical writing is to satisfy the Customer Requirements.

Software Requirement Specification Document

Economic Feasibility Document

Technology Feasibility Document

Operational Feasibility Document

Feasibilty Study Document

Business Requirement Document

Functional Requirement Document

Functional Specification Document

Business Specification Document

Types of Analysis Document

What is Business Analysis?

Instruction Documents

Reporting Documents

Marketing Documents

Marketing documents are those that we use for marketing purpose. Every structured form of document that provides a business is a marketing document.

Following lists few of the types of marketing documents:

White Paper
Proposal
Brochure
Case study
Press Release
Product Handbook
Marketing Script
Advertising Copy
Flyer
Poster
Catalog
Presentation

White Paper

A white paper, in simple words, is a guide that helps in solving the problem of the customer. It mainly should have the following three objectives:

Complete detail about the organization.
Issues faced by the customers.
Solution to solve the issues.

Please Click Here for a sample White Paper document.

Proposal

A Proposal is an initial commercial documentation sent to a customer explaining the solutions and its benefits in addition to the cost and time estimates. It should have the following objectives:

Cover Letter
Project Abstract
Statement of Need
Product Description
Benefits of the Product
Timeline
Budget
Offer Details, if any
Deliverable Details
About the Company
Strength of the Company
Terms and Conditions
Conclusion
Submitted by - information

Please Click Here for a sample proposal document.

Brochure

A brochure is an advertising tool used to introduce a company and its services. It can be distributed by mail or as leaflets to be handed over to the targeted audience.

A Brochure will provide the following three principle attributes:

Information about the company and its services and products
Advertises and promotes the company's business
Provides an identity in the industry, in other words, publicize the company's logo and other identities

A brochure can have any feasible design that is suitable for the objective of the business. The commonly used designs are as follows:

Single Sheet Brochures
Bi-Fold Brochures
Tri-Fold Brochures
Z-Fold Brochures
C-Fold Brochures

A brochure is generally printed on thick glossy paper to enhance the impression and quality.

Please Click Here for a sample Brochure.

Case Study

A Case Study refers to a close analysis of a particular subject. The subject can be anything such as a person, a group, an organization, or an event. A case study can be descriptive or explanatory. It involves research to focus on the discovery or the truth that provoked a positive or a negative result.

A case study should have the following compelling attributes:

Challenge Faced by the subject
Suggested Solution
Results Expected
Results Obtained
Causes of the Obtained Result

Please Click Here for a sample Case Study. This sample case study explains the business strategy of Wal-Mart.

Types of Style Guide

Following are few of the style guides available:

1. Microsoft Manual of Style for Technical Publications (MSTP)
2. Sun Style Guide
3. Chicago Manual of Style
4. Elements of Style
5. Apple Style guide

Though we have many style guides, we can also create our own style guide which follows a standard quality. Here is a tip to enhance your writing style. I follow this whenever I get stuck while writing. Use the help of a word document. That is, just click on the help button of the word document and follow the style of the document. The Microsoft Word Help follows the MSTP style guide. It is simple to use and is very professional.

What is Style Guide?

A style guide is a set of standards used for writing and designing a document. The usage of style guide provides consistency in style and formatting of a document.

The standards created exclusively for developing particular document in an organization is called as “in-house style guide”. There are standards that are established universally for the purpose of creating a standard document. Microsoft Manual of Style for Technical Publications (MSTP) published by Microsoft is one of the commonly followed styles in technical publications. Some style guides focus on images, and some mainly written for the creation of web pages.

Style guides are tools that help the technical writer to develop the documentation offering a professional touch.