* Technical writing is translation.

That’s it, no need for fancy words or definitions.

First, you have rules, ideas, thoughts, principles, information, or whatever. Consider this as the cause.

Then, you find the result. This could be a website, hard copy, soft copy, online help, etc. Consider this as the effect.

Now technical writing is the process shown below.

CAUSE + (YOUR EXPERTISE) = EFFECT

Yet, the step labeled as your expertise, involves several steps. Let’s look at these.

Your Expertise

1. What am I dealing with?

2. What do they want?

3. How do I deliver that want?

4. Is this the best method for delivery?

Using these four steps, any technical writer can tell the POC (point of contact) person the valuable information they require:

1. What needs to be done?

2. When will you be finished?

These two questions summarize everything the POC needs at this point in time.

NOTE: Learning to ascertain end dates is a comparable skill unto itself, but I ALWAYS say when you plan your deadline, always add 3 days to that date, and vice-versa. If you have until Friday the 20th to finish, you should seek to finish the assignment on Tuesday the 17th. Why, what does it matter? It matters because you’ll be known as someone that always finishes and when the pressure’s really on, you won’t be pressured becaus

The first one requires someone with web skills and online reports. Therefore, I will say a good choice would be a certain type of software (crystal reports, mx flash). This type of position requires a very “technical” background as opposed to writing background.

The second requires someone with a particular type of software experience, defined as HELP SYSTEMS. There are several ways to achieve this type of document (adobe framemaker, ms word, adobe acrobat, open office, robohelp, robohelp for framemaker, etc.)

The third one is more of a traditional use of technical writing. The print-manual can be created using any type of commercial publishing software (adobe framemaker, adobe pagemaker, ms word, open office, wordpad, etc.)

From these examples, it’s imperative we first know the needs of the project before we can try seeing “if we fit.”

What exactly does Technical Writing mean?

Officially, we can say that technical writing has no beginning because any person could conclude “the hieroglyphics” were writings of technical caliber to communicate to an audience. And they would be right.

First, we must simplify what we do. Technical writers create documentation using various platforms for a field and/or technology. I am using the word platform because our ever changing world of technology provides several types of mediums to deliver information.

After that, we strive for effective communication through the most efficient means because the purpose of communication is to disseminate information. The technical writer, based on his/her knowledge and experience, chooses the correct platform or medium to release this information.

To adequately present the information accurately and with the most efficiency, we must first understand the following:

* Requirements (optional)

* Audience

* Purpose

* Platform

* Structure

* Content

The Requirements define WHO, WHAT, and WHY in such a limiting fashion, the following points (audience, purpose, platform) are integrated in this step. This step is optional and very prevalent in the telecommunications industry.

The audience defines WHO we are writing the content for. This information dictates the JARGON AND TECHNICAL LEVEL OF OUR STYLE.

The purpose defines WHY we are writing the content. This information dictates the TONE AND COLOR OF OUR STYLE.

The platform defines HOW we are delivering the content. This information usually dictates the SOFTWARE CHOICE.

The structure defines WHICH WAY we are writing. This information dictates the technical aspects of writing (FORMATTING, COLOR, WORD USAGE, PRESENTATION) of our content.

The content defines WHAT we are writing. This information dictates the text and/or messages/meaning of what we are doing. For instance, a document could be created that presented a company’s statistics for the year and without much text, this document would be pages and pages of charts, graphs, and tables. In this instance, these graphics would constitute the content of the document.

The reason why content comes last is that if you change the order, you risk creating problems, adding more time (always a NO-NO), losing effectiveness and efficiency.

For example, you create your content in MS POWERPOINT before you know the purpose. So you choose MS powerpoint and spend a few hours adding graphics and text to make it look more professional. Then you create pdf’s and place the documents online. You’re finished right – NO. The company wants the documents in online help, in XML format, and as print documents.

Now you have to go back, take all your content and graphics, and do the document over in adobe framemaker. Why framemaker? Because FM can output into xml and print format. Now, after finishing the doc in FM, you can use robohelp for framemaker to convert it into several types of online formats. Then you export the FM doc as XML and as a pdf. Now you have finished. The doc is in online help, in XML format, and in print format.

Now imagine if the document needed to be done in one week. You lost two days on Powerpoint and as a result, you have to come in on Saturday and Sunday to finish. That’s not efficient my friend.

Understanding Technical Writing The first obstacle in comprehending technical writing involves a simple truth.

* Technical writing is translation.

That’s it, no need for fancy words or definitions.

First, you have rules, ideas, thoughts, principles, information, or whatever. Consider this as the cause.

Then, you find the result. This could be a website, hard copy, soft copy, online help, etc. Consider this as the effect.

Now technical writing is the process shown below.

CAUSE + (YOUR EXPERTISE) = EFFECT

Yet, the step labeled as your expertise, involves several steps. Let’s look at these.

Your Expertise

1. What am I dealing with?

2. What do they want?

3. How do I deliver that want?

4. Is this the best method for delivery?

Using these four steps, any technical writer can tell the POC (point of contact) person the valuable information they require:

1. What needs to be done?

2. When will you be finished?

These two questions summarize everything the POC needs at this point in time.

NOTE: Learning to ascertain end dates is a comparable skill unto itself, but I ALWAYS say when you plan your deadline, always add 3 days to that date, and vice-versa. If you have until Friday the 20th to finish, you should seek to finish the assignment on Tuesday the 17th. Why, what does it matter? It matters because you’ll be known as someone that always finishes and when the pressure’s really on, you won’t be pressured becaus

To adequately present the information accurately and with the most efficiency, we must first understand the following:

* Requirements (optional)

* Audience

* Purpose

* Platform

* Structure

* Content

The Requirements define WHO, WHAT, and WHY in such a limiting fashion, the following points (audience, purpose, platform) are integrated in this step. This step is optional and very prevalent in the telecommunications industry.

The audience defines WHO we are writing the content for. This information dictates the JARGON AND TECHNICAL LEVEL OF OUR STYLE.

The purpose defines WHY we are writing the content. This information dictates the TONE AND COLOR OF OUR STYLE.

The platform defines HOW we are delivering the content. This information usually dictates the SOFTWARE CHOICE.

The structure defines WHICH WAY we are writing. This information dictates the technical aspects of writing (FORMATTING, COLOR, WORD USAGE, PRESENTATION) of our content.

The content defines WHAT we are writing. This information dictates the text and/or messages/meaning of what we are doing. For instance, a document could be created that presented a company’s statistics for the year and without much text, this document would be pages and pages of charts, graphs, and tables. In this instance, these graphics would constitute the content of the document.

The reason why content comes last is that if you change the order, you risk creating problems, adding more time (always a NO-NO), losing effectiveness and efficiency.

For example, you create your content in MS POWERPOINT before you know the purpose. So you choose MS powerpoint and spend a few hours adding graphics and text to make it look more professional. Then you create pdf’s and place the documents online. You’re finished right – NO. The company wants the documents in online help, in XML format, and as print documents.

Now you have to go back, take all your content and graphics, and do the document over in adobe framemaker. Why framemaker? Because FM can output into xml and print format. Now, after finishing the doc in FM, you can use robohelp for framemaker to convert it into several types of online formats. Then you export the FM doc as XML and as a pdf. Now you have finished. The doc is in online help, in XML format, and in print format.

Now imagine if the document needed to be done in one week. You lost two days on Powerpoint and as a result, you have to come in on Saturday and Sunday to finish. That’s not efficient my friend.

Understanding Technical Writing The first obstacle in comprehending technical writing involves a simple truth.

* Technical writing is translation.

That’s it, no need for fancy words or definitions.

First, you have rules, ideas, thoughts, principles, information, or whatever. Consider this as the cause.

Then, you find the result. This could be a website, hard copy, soft copy, online help, etc. Consider this as the effect.

Now technical writing is the process shown below.

CAUSE + (YOUR EXPERTISE) = EFFECT

Yet, the step labeled as your expertise, involves several steps. Let’s look at these.

Your Expertise

1. What am I dealing with?

2. What do they want?

3. How do I deliver that want?

4. Is this the best method for delivery?

Using these four steps, any technical writer can tell the POC (point of contact) person the valuable information they require:

1. What needs to be done?

2. When will you be finished?

These two questions summarize everything the POC needs at this point in time.

NOTE: Learning to ascertain end dates is a comparable skill unto itself, but I ALWAYS say when you plan your deadline, always add 3 days to that date, and vice-versa. If you have until Friday the 20th to finish, you should seek to finish the assignment on Tuesday the 17th. Why, what does it matter? It matters because you’ll be known as someone that always finishes and when the pressure’s really on, you won’t be pressured becaus

The reason why content comes last is that if you change the order, you risk creating problems, adding more time (always a NO-NO), losing effectiveness and efficiency.

For example, you create your content in MS POWERPOINT before you know the purpose. So you choose MS powerpoint and spend a few hours adding graphics and text to make it look more professional. Then you create pdf’s and place the documents online. You’re finished right – NO. The company wants the documents in online help, in XML format, and as print documents.

Now you have to go back, take all your content and graphics, and do the document over in adobe framemaker. Why framemaker? Because FM can output into xml and print format. Now, after finishing the doc in FM, you can use robohelp for framemaker to convert it into several types of online formats. Then you export the FM doc as XML and as a pdf. Now you have finished. The doc is in online help, in XML format, and in print format.

Now imagine if the document needed to be done in one week. You lost two days on Powerpoint and as a result, you have to come in on Saturday and Sunday to finish. That’s not efficient my friend.

Understanding Technical Writing The first obstacle in comprehending technical writing involves a simple truth.

* Technical writing is translation.

That’s it, no need for fancy words or definitions.

First, you have rules, ideas, thoughts, principles, information, or whatever. Consider this as the cause.

Then, you find the result. This could be a website, hard copy, soft copy, online help, etc. Consider this as the effect.

Now technical writing is the process shown below.

CAUSE + (YOUR EXPERTISE) = EFFECT

Yet, the step labeled as your expertise, involves several steps. Let’s look at these.

Your Expertise

1. What am I dealing with?

2. What do they want?

3. How do I deliver that want?

4. Is this the best method for delivery?

Using these four steps, any technical writer can tell the POC (point of contact) person the valuable information they require:

1. What needs to be done?

2. When will you be finished?

These two questions summarize everything the POC needs at this point in time.

NOTE: Learning to ascertain end dates is a comparable skill unto itself, but I ALWAYS say when you plan your deadline, always add 3 days to that date, and vice-versa. If you have until Friday the 20th to finish, you should seek to finish the assignment on Tuesday the 17th. Why, what does it matter? It matters because you’ll be known as someone that always finishes and when the pressure’s really on, you won’t be pressured becaus

* Technical writing is translation.

That’s it, no need for fancy words or definitions.

First, you have rules, ideas, thoughts, principles, information, or whatever. Consider this as the cause.

Then, you find the result. This could be a website, hard copy, soft copy, online help, etc. Consider this as the effect.

Now technical writing is the process shown below.

CAUSE + (YOUR EXPERTISE) = EFFECT

Yet, the step labeled as your expertise, involves several steps. Let’s look at these.

Your Expertise

1. What am I dealing with?

2. What do they want?

3. How do I deliver that want?

4. Is this the best method for delivery?

Using these four steps, any technical writer can tell the POC (point of contact) person the valuable information they require:

1. What needs to be done?

2. When will you be finished?

These two questions summarize everything the POC needs at this point in time.

NOTE: Learning to ascertain end dates is a comparable skill unto itself, but I ALWAYS say when you plan your deadline, always add 3 days to that date, and vice-versa. If you have until Friday the 20th to finish, you should seek to finish the assignment on Tuesday the 17th. Why, what does it matter? It matters because you’ll be known as someone that always finishes and when the pressure’s really on, you won’t be pressured because you’ve trained yourself to always finish ahead of schedule.