| Actual for You |
Hubs | Hubbers | Topics | Request |
| #1 in Business | Subscribe Email Print |
|
You are here: Home > Writing and Speaking > Writing > New Technical Writer - Use The Persona To Create The Most Useful Section Of Your User Document |
|
Actual for You - New Technical Writer - Use The Persona To Create The Most Useful Section Of Your User Document
Forex Trading Training- Rules For Placing Orders re is not described, then why is it in the product?If you have started your Forex trading training you may initially have a challenge with understanding how orders are placed. I remember when I first started reading about the Forex and practicing in a demo account, it took me a while to understand how stops and limits worked in relation to price.This article sets out the main rules governing the placement of orders with a free graphic download in the resource box at the end which you can keep on your desktop and refer to at anytime until the rules have 'sunk in'. You will find this lesson extremely important if you are in the early stages of your forex trading training.Here are the basics:1. In each currency pair, the first currency is the base currency which you either buy or Thus you have created a topic list for a "classical" User Document. Now we create our User-oriented section, "Fixing Your Picture." Here are the steps: 1. List each of the topics for fixing a picture, using titles that the Reader will understand. 2. Provide a brief overview, perhaps with a picture showing before and after the use of this fixing method. 3. Then list the steps for that topic, and provide links to the documentation for the relevant tools for each step Done! Actually, I would recommend using what I call a "Visual Index," which is described in the links in the "Resources" or "Author Information" section of this article. Within Document Re-usability We could call this organization method "within document re-usability." Here the writing for a topic exists as an item in the "reference" section of the User Document. By referring to that item when it is needed for performing a User- Presentation Fear -- Eight Ways to Cope With and Overcome It A good User Document includes sections on how to set up, use, and care for the product. However, to create a great User Document, the technical writer should use the Persona, generated in the analysis of the User/Reader, to create the topics for the most useful section of the User Document. This article describes this procedure.It has been said for years that when a survey asked people what their greatest fears were, the fear of speaking before a group ranked #1 -- even ahead of death. I don’t have the actual facts on the survey, but I do know that the majority of people who are asked to present experience a great deal of anxiety. In this article, I suggest ways to cope with the fear and anxiety that often accompany giving a presentation.You Are the Expert! You have been asked to give a presentation because you have information that others want to hear about from you. Remember, you have the knowledge that your audience is spending their valuable time to learn. Feel good about yourself. This will start you on your journey to confidence as a presenter. THE MOST USEFUL SECTION OF A USER DOCUMENT The most useful section of a User Document is the one that helps the User get what he/she wants/needs done right now! Writing such a section might seem to be an impossibility. How do you know what the User needs to do now? The only thing that you, as a writer, can do is to play the odds. That is, determine the topics that have the highest probability of being of interest to your User. And "of interest" means "getting what the User wants done, right now." We created Persona (an almost-real representation of your product's User) in another article in the "New Technical Writer" series (see the links in the "Resources" or "Author Information" section of this article). We can use the Persona to create a topic list for this section. USING YOUR PERSONA This step in using your Persona is missed by almost all User Documents that I have seen. Yet this step will result in a User Document that is most satisfying to your Reader. Here it is: Imagine your Persona using your product. Now, what are the main things that your Persona will want to do with your product. As an example we will use a photo editing program (Acme FotoPhixer, a hypothetical product from a hypothetical company) that comes bundled with a point and shoot digital camera. Our Persona is a typical user of such a camera. Ask: What does that Persona want to do with Acme FotoPhixer? The short answer is that they want to improve their photos. HOW can they improve their photos with Acme FotoPhixer? In OUR words (not the words of the User) we could tell them how to: * Rotate * Crop * Red-eye removal * Adjust brightness & contrast * Removing unwanted items from the photo * Focus/Blur * Save * Share These names are what we, the photography experts might use. However, "crop" may be meaningless to our Persona. In fact, we could move crop into "Removing unwanted items from the photo." The "Focus/Blur" topic is interesting. If a photo is out of focus or blurred, there is really nothing that our software can do to improve it. However our Reader does not know this, but still wants to do it. We should include topic with this text: "It is impossible to fix the focus or remove blurring in a photograph. You might be able to improve this using the [Sharpen Effect] tool in FotoPhixer." (The [] specifies a reference to the topic in the User Document.) DON'T HIDE THIS SECTION If your Reader cannot quickly find what he/she wants to do in your User Document, then the document has failed. Since we created this section to answer the User's pressing needs for the product, then we must make this section very accessible to the User -- they have to be able to find it easily. "Fixing (Improving) Your Picture" is a PERFECT, User-oriented title. That is the correct title for this section. Don't bury this gold under titles such as: "Tutorial" or "Use FotoPhixer's Tools." These titles do not suggest answers to the User's questions. You should make this section very easy to find in the User Document. It's the key section of the User Document. It has the information that most Readers want, most of the time (by your analysis). Place it prominently in the User Document. SATISFYING THE READER IS EASIER THAN YOU THINK Producing this section is easier than you think. First, imagine that you were NOT going to include this section. Your User Document would still have to cover all of the features, tools, and user interactions for the product. You need to do that to satisfy your boss. It's also logical. If a feature is not described, then why is it in the product? Thus you have created a topic list for a "classical" User Document. Now we create our User-oriented section, "Fixing Your Picture." Here are the steps: 1. List each of the topics for fixing a picture, using titles that the Reader will understand. 2. Provide a brief overview, perhaps with a picture showing before and after the use of this fixing method. 3. Then list the steps for that topic, and provide links to the documentation for the relevant tools for each step Done! Actually, I would recommend using what I call a "Visual Index," which is described in the links in the "Resources" or "Author Information" section of this article. Within Document Re-usability We could call this organization method "within document re-usability." Here the writing for a topic exists as an item in the "reference" section of the User Document. By referring to that item when it is needed for performing a User-o Are You Drowning In Debt he "Resources" or "Author Information" section of this article). We can use the Persona to create a topic list for this section.If you are deep in debt and it seems that there is no way out, there is hope. Credit card counceling and/or debt consolidation may be the best solutions to your problems.A credit counceling professional can help you establish a plan to get out of debt and help you learn ways to stay out. Credit counselors will work with you to create a debt management program, which may include debt consolidation, and they will also educate you on how to avoid the careless spending and lax payments that landed you in debt in the first place. With the help of a credit counselor, it won't be long before you are transformed into a responsible and reliable consumer.When you begin a debt management program, your objective is to completely eliminate all of your USING YOUR PERSONA This step in using your Persona is missed by almost all User Documents that I have seen. Yet this step will result in a User Document that is most satisfying to your Reader. Here it is: Imagine your Persona using your product. Now, what are the main things that your Persona will want to do with your product. As an example we will use a photo editing program (Acme FotoPhixer, a hypothetical product from a hypothetical company) that comes bundled with a point and shoot digital camera. Our Persona is a typical user of such a camera. Ask: What does that Persona want to do with Acme FotoPhixer? The short answer is that they want to improve their photos. HOW can they improve their photos with Acme FotoPhixer? In OUR words (not the words of the User) we could tell them how to: * Rotate * Crop * Red-eye removal * Adjust brightness & contrast * Removing unwanted items from the photo * Focus/Blur * Save * Share These names are what we, the photography experts might use. However, "crop" may be meaningless to our Persona. In fact, we could move crop into "Removing unwanted items from the photo." The "Focus/Blur" topic is interesting. If a photo is out of focus or blurred, there is really nothing that our software can do to improve it. However our Reader does not know this, but still wants to do it. We should include topic with this text: "It is impossible to fix the focus or remove blurring in a photograph. You might be able to improve this using the [Sharpen Effect] tool in FotoPhixer." (The [] specifies a reference to the topic in the User Document.) DON'T HIDE THIS SECTION If your Reader cannot quickly find what he/she wants to do in your User Document, then the document has failed. Since we created this section to answer the User's pressing needs for the product, then we must make this section very accessible to the User -- they have to be able to find it easily. "Fixing (Improving) Your Picture" is a PERFECT, User-oriented title. That is the correct title for this section. Don't bury this gold under titles such as: "Tutorial" or "Use FotoPhixer's Tools." These titles do not suggest answers to the User's questions. You should make this section very easy to find in the User Document. It's the key section of the User Document. It has the information that most Readers want, most of the time (by your analysis). Place it prominently in the User Document. SATISFYING THE READER IS EASIER THAN YOU THINK Producing this section is easier than you think. First, imagine that you were NOT going to include this section. Your User Document would still have to cover all of the features, tools, and user interactions for the product. You need to do that to satisfy your boss. It's also logical. If a feature is not described, then why is it in the product? Thus you have created a topic list for a "classical" User Document. Now we create our User-oriented section, "Fixing Your Picture." Here are the steps: 1. List each of the topics for fixing a picture, using titles that the Reader will understand. 2. Provide a brief overview, perhaps with a picture showing before and after the use of this fixing method. 3. Then list the steps for that topic, and provide links to the documentation for the relevant tools for each step Done! Actually, I would recommend using what I call a "Visual Index," which is described in the links in the "Resources" or "Author Information" section of this article. Within Document Re-usability We could call this organization method "within document re-usability." Here the writing for a topic exists as an item in the "reference" section of the User Document. By referring to that item when it is needed for performing a User- Advertisements - Varieties and Forms Reviewed removalFrom the psychological point of view advertisements may be classified according to their general purpose or intention and also according to the particular tasks which they set themselves. Thus we may have the three following types, according to the task attempted: Classified Advertisement. Takes initial attention, interest, and memory for granted, and merely seeks to direct the response.Publicity Advertisement. Takes for granted the elements of persuasion, decision, and response, and merely tries to accomplish the tasks which the Classified Advertisement explicitly ignores - namely, to attract and hold attention, and to fix an impression in the reader's mind.Complete Advertisement. Attempts to perform all the various tasks of * Adjust brightness & contrast * Removing unwanted items from the photo * Focus/Blur * Save * Share These names are what we, the photography experts might use. However, "crop" may be meaningless to our Persona. In fact, we could move crop into "Removing unwanted items from the photo." The "Focus/Blur" topic is interesting. If a photo is out of focus or blurred, there is really nothing that our software can do to improve it. However our Reader does not know this, but still wants to do it. We should include topic with this text: "It is impossible to fix the focus or remove blurring in a photograph. You might be able to improve this using the [Sharpen Effect] tool in FotoPhixer." (The [] specifies a reference to the topic in the User Document.) DON'T HIDE THIS SECTION If your Reader cannot quickly find what he/she wants to do in your User Document, then the document has failed. Since we created this section to answer the User's pressing needs for the product, then we must make this section very accessible to the User -- they have to be able to find it easily. "Fixing (Improving) Your Picture" is a PERFECT, User-oriented title. That is the correct title for this section. Don't bury this gold under titles such as: "Tutorial" or "Use FotoPhixer's Tools." These titles do not suggest answers to the User's questions. You should make this section very easy to find in the User Document. It's the key section of the User Document. It has the information that most Readers want, most of the time (by your analysis). Place it prominently in the User Document. SATISFYING THE READER IS EASIER THAN YOU THINK Producing this section is easier than you think. First, imagine that you were NOT going to include this section. Your User Document would still have to cover all of the features, tools, and user interactions for the product. You need to do that to satisfy your boss. It's also logical. If a feature is not described, then why is it in the product? Thus you have created a topic list for a "classical" User Document. Now we create our User-oriented section, "Fixing Your Picture." Here are the steps: 1. List each of the topics for fixing a picture, using titles that the Reader will understand. 2. Provide a brief overview, perhaps with a picture showing before and after the use of this fixing method. 3. Then list the steps for that topic, and provide links to the documentation for the relevant tools for each step Done! Actually, I would recommend using what I call a "Visual Index," which is described in the links in the "Resources" or "Author Information" section of this article. Within Document Re-usability We could call this organization method "within document re-usability." Here the writing for a topic exists as an item in the "reference" section of the User Document. By referring to that item when it is needed for performing a User- To All Those That Just Don't Get It er's pressing needs for the product, then we must make this section very accessible to the User -- they have to be able to find it easily.I may not be Miss Manners, but I do know a thing or two about how to relate with people. Call it life experience or something, but I call it common sense. I also call it politeness and "didn't your momma teach you anything?"Personally, I am there for you if you have a serious issue. There are also many forums and different kinds of support groups. I know, I have gone into several and broken down about some issues - however, I don't whine in front of millions of people. There are times and places for different things, and it doesn't take much to know where and when to keep your mouth shut.For those of you who just don't understand this concept, never learned it, and/or rebel from the laws of society, I have compiled this short list of common "Fixing (Improving) Your Picture" is a PERFECT, User-oriented title. That is the correct title for this section. Don't bury this gold under titles such as: "Tutorial" or "Use FotoPhixer's Tools." These titles do not suggest answers to the User's questions. You should make this section very easy to find in the User Document. It's the key section of the User Document. It has the information that most Readers want, most of the time (by your analysis). Place it prominently in the User Document. SATISFYING THE READER IS EASIER THAN YOU THINK Producing this section is easier than you think. First, imagine that you were NOT going to include this section. Your User Document would still have to cover all of the features, tools, and user interactions for the product. You need to do that to satisfy your boss. It's also logical. If a feature is not described, then why is it in the product? Thus you have created a topic list for a "classical" User Document. Now we create our User-oriented section, "Fixing Your Picture." Here are the steps: 1. List each of the topics for fixing a picture, using titles that the Reader will understand. 2. Provide a brief overview, perhaps with a picture showing before and after the use of this fixing method. 3. Then list the steps for that topic, and provide links to the documentation for the relevant tools for each step Done! Actually, I would recommend using what I call a "Visual Index," which is described in the links in the "Resources" or "Author Information" section of this article. Within Document Re-usability We could call this organization method "within document re-usability." Here the writing for a topic exists as an item in the "reference" section of the User Document. By referring to that item when it is needed for performing a User- For A Fresh and Auspicious Start- Small Business Startup Loans re is not described, then why is it in the product?Your growth and success of business depends upon how strong the foundation is. If you do not have a strong foundation, your business may face setbacks in the future. In order to prevent your business from this situation, give it a strong base by availing small business startup loans. Sometimes because of insufficient fund while starting a new business, you fail to give proper backup and suffice it with resources. This leads in the failure of your business. Small business startup loans are thus offered to give your business a healthy start.Small business startup loans are available to meet the initial requirements while starting a business. With this loan you can buy your office plot, manpower, furniture, and other resources necessary to initiate a Thus you have created a topic list for a "classical" User Document. Now we create our User-oriented section, "Fixing Your Picture." Here are the steps: 1. List each of the topics for fixing a picture, using titles that the Reader will understand. 2. Provide a brief overview, perhaps with a picture showing before and after the use of this fixing method. 3. Then list the steps for that topic, and provide links to the documentation for the relevant tools for each step Done! Actually, I would recommend using what I call a "Visual Index," which is described in the links in the "Resources" or "Author Information" section of this article. Within Document Re-usability We could call this organization method "within document re-usability." Here the writing for a topic exists as an item in the "reference" section of the User Document. By referring to that item when it is needed for performing a User-oriented task, we make the text do double duty. This results in reusability within the document. HOW TO GET THE TIME TO WRITE THIS SECTION Put less detailed effort into the documentation for the product's features that will be rarely used. For example, FotoPhixer includes tools to make the image look like it's made of stone, or produce 3D effects, etc. These are rarely used, and have a similar set of controls. Instead of detailing the use of each of these rarely used features, write a global usage, describe the controls, encourage the User to experiment, and remind them of the un-do and cancel capabilities. You can create the "most useful" section with the time you save by not thoroughly documenting these rarely-used items. THE BOTTOM LINE You can make your User Document much more effective if you think about your User/Reader and what he/she wants to do with the product. Use this information to create an easy to find section in your User Document that meets your Reader's needs.
HTTP = HTML link (for blogs, profiles,phorums):
Related Articles:Small Employers Rejoice - IRS Simplifies Filings Reverse Mortgage Wholesaler - Hassle Free Experience
|