Tags |
|
|
Links |
|
|
Atricle Dump - What is Technical Writing?
You are now ready to begin writing. But do not start right away. You will need to do some writing warm-ups before you get going. Start with your three word practice session as we described at the beginning of this chapter. After you have done this two or three times, you will be ready to go. Sit in a place where you will not be interrupted. Any disruption to the flow will kill any ideas you have and your creativity will be lessened. I have to hide in my office, turn off the phones, shut down the email and close the door.If you have a timer or a watch with a timer, set it for five minutes. Start with the first topic in your first chapter. Look at the question and then the three descriptors. These are the words you will use when you write. Set the timer and start writing the answer to your question. Keep writing until the timer goes off. At that point stop at the end of your sentence. At this point you
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 fram
Currency trading, just like other trading fields, involves the risk of loss. This risk increases because of the trader’s psychological weaknesses. Human features make the difference between the successful and always loosing investor. Here’s how to avoid making psychological mistakes while Currency trading.There have been written many books about the psychological aspect of the trading business and Currency trading is no exception, even if the risk is diminished here. History, other people’s experience and impressive statistics have proven that more people loose, while trading, than win. Economic techniques, forecasting methods and communication technology have advanced over time, yet we still see there are no changes in the statistics: more losers than winners. This is due to the fact that human nature is the same and it is the one that we should pay more attention to.The probability of becomi
Simply, a technical writer creates documentation for a field and/or technology. But that doesn’t help describe the different nuances of this varied field. The great thing about technical writing is its chameleon-like ability to fuse into other positions and the worst thing is its under-appreciation from ignorance of the position’s purpose.
To understand this field, you must first know its purpose. A technical writer communicates a message, that’s simple right? But when you add the technologies and the tools involved (see my book the tools of technical writing for more information), you can get confused.
Here are a few examples of how technology impacts your ability to do documentation:
* A telecommunications company wants their stats delivered via an online report that shows information in real-time
* A software company wants their manuals delivered as online help
* A small airline business wants their general maintenance manual delivered as standardized hard copy
From these needs, we can easily find the purpose, and with that purpose, we know the type of skills required to perform these duties.
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 frame
After many months of worrying, searching, and procrastinating you finally decide to take the plunge. Are you ready for this? Here’s what I found you absolutely need to start and run a successful small business on the Web.Deceptively SimpleIf you are reading this, you can obviously navigate on the Web. You also have a more than passing interest for the subject clearly stated in the title of this article.Furthermore, I would be willing to bet that you can already use your personal computer to create written documents, such as emails, or a more elaborate document, such as your personal resume (curriculum vitae).You may even be using your computer to do your budget, for all I know.Intuitively, you know you will need a Web site to market your Web business. You believe that you should know something about how to build a Web site that will serve the purposes of the small busines
* A telecommunications company wants their stats delivered via an online report that shows information in real-time
* A software company wants their manuals delivered as online help
* A small airline business wants their general maintenance manual delivered as standardized hard copy
From these needs, we can easily find the purpose, and with that purpose, we know the type of skills required to perform these duties.
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 fram
Managing cash flow is what separates good companies from the truly successful ones. Indeed, your ability to monitor the cash flow of your business can be the vital difference between profit and loss.Here are 10 ideas to enhance cash flow:Assess Your Risk Up Front When you do work without being paid up front, you are extending credit. Discuss your billing procedures with your customers up front. "We expect payment in 30 days; is that a problem?" If it is, you need to know ahead of time and make an informed decision about whether you really want to loan your new customer money.Bill ImmediatelyCustomers do not pay for what they have not yet been billed. Although many owners believe they have efficient billing procedures, our experience is that delayed billing is a primary cause of poor ca
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 fram
Some people call a meeting at the drop of any problem. And the result is often a complete waste of time.Here's what to do instead.1) As soon as you feel the urge to call a meeting, before doing anything else, write out the goal for the meeting. These are the results that you want to have at the end of the meeting.2) Test if your goal is specific enough that someone else could lead the meeting based on what you have written. A goal such as "new budget," can be interrupted differently by everyone who attends. Instead write a specific goal such as, "Identify items that can be deleted from the budget resulting in a savings of 5%."3) Test if the goal is realistic. Can it be accomplished with the time and resources available for the meeting?4) Test if the goal will help advance your business. If the goal has nothing to do with your business, ask yourself why you want to spend re
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 fram
If you are an individual with poor credit and are considering a bad credit mortgage from a sub-prime mortgage lender, there are a number of factors you need to consider before applying. Sub-Prime mortgage lenders specialize in bad credit mortgages for homeowners that have credit problems in their past, at a premium price. Here are several tips to help you secure a mortgage with bad credit without losing your shirt.If you have credit problems in your past many traditional mortgage lenders will deny your mortgage application. Sub-prime or bad credit lenders are the only option for many homeowners. This financing comes with a premium interest rate and higher fees than traditional mortgage loans. The majority of sub-prime mortgage lenders operate honest business; however, there are a number of these lenders that try and take advantage of your situation for their own financial gain.Predatory mo
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 because you’ve trained yourself to always finish ahead of schedule.
HTTP = HTML link (for blogs, profiles,phorums):
<a href="http://www.articledump.net/article/164462/articledump-What-is-Technical-Writing.html">What is Technical Writing?</a>
BB link (for phorums):
[url=http://www.articledump.net/article/164462/articledump-What-is-Technical-Writing.html]What is Technical Writing?[/url]
Related Articles:
Marketing for Builders Using DVD
Book Review - How to Get What You Want in Life With the Money You Already Have
Bookmark it:
|