Fresh Mechanical Writer: Employ The Persona To Actualize The Most Good Cut Of Your User File
OVERVIEW
A acceptable User File includes sections on how to establish, employ, and affliction for the product. But, to actualize a abundant User File , the mechanical writer should employ the Persona, generated in the discussion of the User/Reader, to actualize the topics for the most good cut of the User File. This article describes this procedure.
THE MOST Good Cut OF A USER File
The most good cut of a User File is the one that helps the User amuse what he/she wants/needs done appropriate immediately!
Writing such a cut might seem to be an impossibility. How accomplish you understand what the User needs to accomplish immediately?
The alone object that you, as a writer, can accomplish is to play the odds. That is, actuate the topics that accept the highest probability of life of absorption to your User. And “of absorption” method “getting what the User wants done, appropriate immediately.”
We created Persona (an almost-real model of your product’s User) in another article in the “Fresh Mechanical Writer” series (look the links in the “Means” or “Author Advice” cut of this article). We can employ the Persona to actualize a topic file for this cut.
USING YOUR PERSONA
This process in using your Persona is missed by nearly all User Documents that I accept seen. Even this process will aftereffect in a User File that is most satisfying to your Reader. Here it is:
Visualize your Persona using your product. Immediately, what are the leading matters that your Persona will desire to accomplish with your product.
As an archetype we will employ a photo editing programme (Acme FotoPhixer, a hypothetical product from a hypothetical corporation) that comes bundled with a mark and shoot digital camera. Our Persona is a general user of such a camera.
Buzz: What does that Persona desire to accomplish with Acme FotoPhixer?
The short return is that they desire to advance their photos. HOW can they advance their photos with Acme FotoPhixer? In OUR text (not the text of the User) we could impart them how to:
* Rotate
* Crop
* Red-eye removal
* Adjust brightness & contrast
* Removing unwanted items from the photo
* Bull’s eye/Blur
* Save
* Print
* Hand
These names are what we, the photography experts might employ. But, “crop” may be meaningless to our Persona. Actually, we could act crop into “Removing unwanted items from the photo.”
The “Bull’s eye/Blur” topic is absorbing. Provided a photo is outside of bull’s eye or blurred, there is actually annihilation that our software can accomplish to advance it. But our Reader does not understand this, however even wants to accomplish it. We should comprehend topic with this content: “It is impossible to set the bull’s eye or remove blurring in a photograph. You might be able to advance this using the [Sharpen Effect] thing in FotoPhixer.” (The [] specifies a reference to the topic in the User File.)
DON’T Adumbrate THIS Cut
Provided your Reader cannot quickly acquisition what he/she wants to accomplish in your User File, then the file has failed. Because we created this cut to reply the User’s urgent needs for the product, then we must accomplish this cut too accessible to the User — they accept to be able to acquisition it easily.
“Fixing (Improving) Your Picture” is a Complete, User-oriented name. That is the right name for this cut. Don’t bury this gold under titles such as: “Tutorial” or “Employ FotoPhixer’s Tools.” These titles accomplish not propose answers to the User’s questions.
You should accomplish this cut too accessible to acquisition in the User File. It’s the answer cut of the User File. It has the advice that most Readers desire, most of the age (by your discussion). Put it prominently in the User File.
SATISFYING THE READER IS EASIER THAN YOU Anticipate
Producing this cut is easier than you anticipate.
Aboriginal, visualize that you were NOT going to comprehend this cut. Your User File would even accept to include all of the features, tools, and user interactions for the product. You charge to accomplish that to satisfy your boss. It’s again logical. Provided a fact is not described, then why is it in the product?
Thus you accept created a topic file for a “classical” User File.
Immediately we actualize our User-oriented cut, “Fixing Your Picture.” Here are the steps:
1. File each of the topics for fixing a picture, using titles that the Reader will accept.
2. Accommodate a little overview, maybe with a picture showing before and after the employ of this fixing means.
3. Then file the steps for that topic, and accommodate links to the documentation for the important tools for each process
Done!
Indeed, I would reccomend using what I phone a “Visual Index,” which is described in the links in the “Means” or “Author Advice” cut of this article.
Within File Re-usability
We could phone this group means “within file re-usability.” Here the writing for a topic exists as an thing in the “reference” cut of the User File. By referring to that thing when it is needed for performing a User-oriented assignment, we accomplish the content accomplish twin work. This results in reusability within the file.
HOW To receive THE Age TO Address THIS Cut
Lay less detailed accomplishment into the documentation for the product’s features that will be seldom used. For archetype, FotoPhixer includes tools to accomplish the angel attending love it’s fabricated of stone, or make 3D thing, etc. These are seldom used, and accept a agnate locate of controls. Instead of detailing the employ of each of these seldom used features, address a global usage, call the controls, animate the User to experiment, and remind them of the un-do and cancel capabilities.
You can actualize the “most good” cut with the age you save by not thoroughly documenting these rarely-used items.
THE Backside Border
You can accomplish your User File even added able provided you anticipate approximately your User/Reader and what he/she wants to accomplish with the product. Employ this advice to actualize an accessible to acquisition cut in your User File that meets your Reader’s needs.
