Making the user guide is a meticulous job. Misspellings, inappropriate style, eloquence and vague instructions are considered by users as well as the shortcomings of the software product, which produces a negative impact on the credibility of the product and the company that created it. Editors and bloggers can give these programs the negative reviews, swaying potential customers to competing products.
In this article, I will describe the common mistakes that can be found in the instructions and make recommendations on how to izbjeći.Preporuke below are not exhaustive of all possible errors and therefore should be used in conjunction with rules that have already follow when creating a user guide.
So, what are the common mistakes in user manuals?
1 Vague description of the
Write the proceedings as clearly as possible, so that the user understands what to do at first glance. First, tell me where the procedure takes place, then the user what to do (click, open, select, close, etc. ).
Example:
Wrong: Select Open from the File menu.
Right: On the File menu, select Open
2 Describing the various steps in one sentence
writers often describe complex, multi-step process in one sentence. To clear description of the procedure, you must separate the complex sentences in steps.
Example:
Wrong: Please send us a screenshot (we recommend using a jet taking screen) that shows what the problem is.
right:
Please send us a screenshot that shows the problem.
To take a screenshot, please use the Jet Screenshot.
3 Failure to define the steps correctly
a complex process consisting of several steps. Each step must describe the action and result. However, there are user guides, where actions and results are divided into separate steps. This is a common mistake.
Example:
is wrong:
1st Select the Directory tab.
2.Imenik window.
3rd Click a contact.
4.Kontaktirajte profile opens.
Right:
1.Select Directory tab.
Directory window.
2nd Click a contact.
Contact profile opens.
right too:
1 Select the Directory tab.
2nd On the Contacts window, click Contacts.
4 The titles in quotation marks
In many of the user guide you can see the titles in quotation marks. Today this method is becoming obsolete. The quotes are taken back to the days when you type machines had no choice to format the text, but use the quotes or underline. Now, it is best to write the titles in bold capital letters or use the characters.
Example:
Wrong: "Remove" button removes the file from the list.
Right: The Remove button removes the file from the
also entitled to:. Remove button removes the file from the
5 And / or
Do not use 'and / or "in sentences. It makes the text harder to read and understand, so that the reader has to read sentences over and over again. Instead of' and / or" use "... or ... or both'.
For example:
Wrong: You can convert files in AVI and / or MP3.
Right: You can convert files to AVI or MP3, or both
6 Misuse of the terms
an inexperienced writer often makes mistakes in terms.
Example:
Incorrect: Click the New icon to create a new project.
Right:. Click the new icon to create a new project
of the verb 'hit' means pressing a key on the keyboard, while the 'click' means click on the icon in the window with the mouse.
7 Future time
There are lots of user guides which is a result of the action expressed in the future tense. For example: "When you click the OK button, the program will begin the conversion." It is a mistake. Because futuro reader feels insecure and May want to ask unnecessary questions like: "When the conversion begin? 'or' What if it does not start? Why do readers can ask these questions? The answer is simple.
of the verb 'will', which today is used to express the future, initially took the form of "William." This is a modal verb expressing the will. Sometimes, "William" is used when people talk about their future plans as there is no special form for the future in Old English. Over time, "William" reduced to "will", but it still preserves its original modal meaning. For example, will be clearly seen in the phrase: "pencil will not write'.
Therefore, when you read the sentence 'When you click the OK button, the program will start conversion ", the verb" shall "expresses the future and will. It sounds as if the program is" wanted "to start conversion. But what if do not 'want' to? to avoid ambiguity, the present should be used.
is wrong: When you click the OK button, the program will start converting.
Right:. When you click the OK button, the program starts the conversion of
8 Jargon
Technical writers should stick to neutral stil.Korištenje expressive words distracts the reader and is considered a stylistic error that should be avoided.
Example:
Wrong: Kill approx.
Right:. Close the program
Wrong: Hit the Search button.
Right Click the Search button
9 Abbreviations
user guide should not contain abbreviations and other terms decrease.
Example:
Wrong: approx.
Right: about
is wrong: eg
Right: for example,
The phrase is composed of several words should not be shortened if used only once throughout the text. However, if the term appears several times, you should put your short for parentheses immediately after the term used for the first time. In all cases, further abbreviations should be used to describe this notion.
Example:
Right:
Oxygen Software today introduces an enhanced version of its Oxygen Phone Manager II (OPM II) for Nokia and Vertu telefone.Najveća changes in OPM II is tested quality support for groundbreaking series of 40 5 edition phones of Nokia, whose Posh looks and cool features they have won the hearts of millions of people.
Conclusion
user guide are all about clarity and accuracy. To achieve these properties, you need a solid knowledge of grammar and stylistics. A poorly written documents can backfire and cause users to feel discomfort and irritation, which may lead them to making a choice in favor of competition. I hope these tips will help you make your technical documentation, better and easier for end users to read.
Tidak ada komentar:
Posting Komentar