| File Name: | how to user manual.pdf |
| Size: | 2091 KB |
| Type: | PDF, ePub, eBook, fb2, mobi, txt, doc, rtf, djvu |
| Category: | Book |
| Uploaded | 26 May 2019, 18:22 PM |
| Interface | English |
| Rating | 4.6/5 from 653 votes |
| Status | AVAILABLE |
| Last checked | 1 Minutes ago! |
Increasingly companies are rethinking the way they approachIt is often tossed aside as being either secondary, or just too difficult to deal with. When this happens, the user, the product and the writing team all suffer in some way. In order toThese guidelines can help. Often this is due to the fact that the key words the writer has used are not the key words that users may search for. Here are some guidelines thatIt is critical that the instructions are easy to read and are understandable by all users. Many user manuals have instructions that are incomplete, incorrect, or simply have no bearing onHave an independent user then follow the steps (literally) with the product and check that:Here are some suggestions. Here are some basic guidelines to ensure your user manual will survive actual use. His book, Think Like a UX Researcher, was published in January 2019. More details Want in? Sign up now and get free, exclusive access to our reports and eBooks. His book, Think Like a UX Researcher, was published in January 2019. How end user documentation is part of the customer experience. How good user documentation can help take the burden off your customer support team. Why visual content is the secret ingredient to the best documentation. The essential elements that ensure the best user documentation. The four steps to creating documentation that delights your customers and stands the test of time. Create step-by-step guides with a simple and professional look. Software documentation shows you what your purchase can do and how to do it. You want your customers to know it, too. User documentation helps ensure your customers or users actually learn how to get the most out of your product. I mean, just write some stuff about how to use your product and you’re good to go! It’s part of the customer experience. And that means it’s also marketing material. I bet most of you have had similar experiences.http://buyanycarnow.com/uploadedfiles/comparex-manual.xml
Having great user documentation helps out your support team in two major ways. Your product support team can use documentation to help better support your customers when they call. When you include essential pieces such as a table of contents or index, they can quickly find the information they need. And, if it’s a searchable electronic document, that’s even better. We’ll learn more about this later in the article. But, if customers can figure it out themselves they’re far less likely to need help. In fact, more than 70 percent of people prefer to use a company’s website for help rather than use a phone or email. No one wants to feel dumb. Making your customer feel that way is certainly no way to foster a great experience. You know all kinds of jargon, acronyms, and other “insider” info that customers likely don’t. It’s natural for you to use it. Write it for them. Write the documentation in an easy-to-read way. This applies both to the document’s content as well as its design. Long blocks of text and pages tightly packed with written and graphic content can make user guides or manuals feel intimidating and unfriendly. And, they’re far less likely to have a good customer experience. They don’t have to read about, they can see it! Sometimes called simplified user interface (or SUI), simplified graphics take images of a user interface or other graphic and — just as the name suggests — simplifies them. This more basic version highlight the most essential information while reducing text and graphics that aren’t important to simpler shapes. But too often, we’re so in love our cool product features, all we want to do is highlight what it can do rather that why our customers need it. It’s about the why, not just the how. And that hierarchy should follow a logical flow that helps the user learn to use your product in the most helpful way. Start with the easy stuff first and then, as your users build their knowledge, show them the advanced features.http://deauville.ru/files/comparison-between-automatic-and-manual-cars.xml
It’s right at the beginning of the document so they don’t have to sift through pages of text to find what they’re looking for. It should include all the major headings and subheadings as described above. Now, in an era where just about everyone has access to a smartphone, it makes more sense to create electronic documentation. That doesn’t mean you can’t create print versions, too, but an electronic version offers a number of advantages we’ll into in more detail below. This means ensuring that electronic documentation adheres to standards of accessibility for people who may be blind or visually impaired, deaf or hard of hearing, or may have cognitive disabilities. Don’t leave them behind! Make it usable and friendly. Avoid long paragraphs of text or pages that are packed too full of content. Allow for white space to help break up the monotony and make the prospect of learning a new product less daunting. For electronic documentation, use video and gifs. If your organization has a style guide (which I HIGHLY recommend you should), make sure your documentation adheres to it. Simply gather the images you need, choose Create and Image from Template and you’re on your way. Find out what they tell you they need to know to best use your products. While some of it might be obvious, I guarantee you’ll learn things you never even considered. For electronic user documentation, this can be as simple as providing links to tutorials, FAQs, user forums, and more. They’re easier to follow, easier to understand, and offer a much more user-friendly experience than simply telling someone how to complete a task. Plus, the Combine Images Tool enables you to combine individual screenshots and other images into a single image for easier editing and mark up. Here are some tips on how to get where you’re going. Instead, start with a plan to ensure that you’re actually helping your users. What should you leave out? (Hint: This is where user feedback can be REALLY helpful!
) In what order should we present the information? (Remember essay outlines from middle school. Who is responsible for creating the document. Who is responsible for feedback on the document. Who has final approval. Will this need to be translated or localized? Planning ensures a smooth process and a better user document. Will it be print-only. Will it be electronic. If so, where will it live? But, unless you have a very good reason, I recommend at least having an electronic version available on your website. Putting user resources online gives them access wherever they may be, meaning they don’t have to go searching through drawers or file cabinets to find a user manual they haven’t seen in years. A print-only version will work for most people, but are you prepared to create a braille version for users who may be blind or visually impaired. What about users who have a physical disability where it’s difficult for them to manipulate objects with their hands? Instead, make an electronic version available on your website as normal website text. There are a number of reasons for it, but it all boils down to this: It’s just easier to use. But make sure it’s available on your website in a non-PDF format, as well. I’m not going to presume to tell you how EXACTLY to create the documentation for your specific product, but there are some key things to keep in mind. Avoid acronyms unless you explain what they mean. Use a commonly recognized writing style such as AP or Chicago whenever possible. If your organization has a company style guide, use that. Don’t assume the user knows anything about your product or what it does. SHOW them what they need to know to be successful. Remember to use plain language. Write for an eighth-grade level. Even for advanced readers, simple language leads to faster processing and better comprehension. The design should be pleasing, non-intimidating, and draw the user in. Make them WANT to use your documentation.
And you can’t know that until someone uses it. Before your new creation goes out into the world at large, you want to test it. Here are a few tips! Incorporate their feedback into the finished document. If you don’t have beta testing user feedback, test it internally, preferably with employees who are least familiar with the product. Get feedback from the developers and engineers. They know the product better than anyone and they can point out things you may have missed. As noted above, this gives electronic documentation a huge advantage over print. However, even print-only docs can be updated and made available for download on your website. Be sure that what you give your customers actually helps them use your product. Create step-by-step guides with a simple and professional look. User documentation (also called end user manuals, end user guides, instruction manuals, etc.) is the content you provide end users with to help them be more successful with your product or service. What are the types of user documentation. In the past, user documentation was given via a help file that was local to the user’s machine or a physical manual or booklet. Nowadays, user documentation is almost always offered online, which has helped technical writers be more imaginative in how they assist users. What is included in user documentation. Great user documentation should include: Plain language, simplicity, visuals, a focus on the problem, a logical hierarchy and flow, a table of contents, searchable content, accessible content, good design, feedback from real users, and links to further resources. How do you create a user document. Great user documentation can be made in four simple steps: First Know your goals and create a plan to achieve them. Next, create your guide based on your plan. Then test out your guide to make sure it does the job before you set it free. Finally, keep it up to date. When your product changes, update your documentation to reflect the changes. Geek.
Science Enthusiast. Hufflepuff. Retired roller derby coach. A few things about me. By using our site, you agree to our cookie policy.Learn why people trust wikiHow In this case, 83% of readers who voted found the article helpful, earning it our reader-approved status.A user manual is a formal writing piece with a specific structure, and should be written by someone who is intimately familiar with the product such as a technical writer or the product designer. Writing an effective user manual requires knowing who is going to be using the product, then writing it with these users in mind. Keep your writing clear, precise, and simple in order to ensure a problem-free user experience.The user manual should be written for the audience -- those who will be purchasing your product or service and reading the user manual. An audience analysis will tell you who your main or target audience will be and will guide your writing.Offer test users prototypes of the device and a draft of the user manual under controlled conditions. Solicit these test users’ feedback about things that are not obvious or confusing in the user directions and incorporate changes into your user manual based on this feedback. If you were part of the team that helped design and develop the device or product, it might be hard to look at the product objectively in order to explain its operation. You might, therefore, want to solicit the advice of a writer (preferably one with experience in writing instructions) and graphic designer in order to help you draft the user manual. You could choose these individuals from an outside consultancy or from your own company or organization.A thorough task analysis will identify the materials and equipment (such as batteries, medications, or other user-provided products) needed for each step, as well as the actions, errors, and troubleshooting advice that each step might require.
For instance, in a car, you can honk the horn, strap yourself in, and turn your headlights on or off. Create a task analysis for each of these as needed. These requirements ensure that products are produced with user safety in mind, and will limit user exposure to dangerous conditions such as radiation and electrocution. Advertisements must demonstrate clearly what the purpose and basic operational guidelines of a product are, and you should use these sources when writing your user manual.There are several important ways you can streamline your manual. You should place a bold heading at the start of each section with each word capitalized. For instance, “Setting Up Your Device,” “Operating Your Device,” and “Troubleshooting” could all be bold section headings.You could also use a flow chart to provide the user with directions. Think about your product and how each method might be of use when writing your user manual. However, avoid mixing different layouts within a manual. Choose one and stick with it. The user manual should proceed in a way that the user will find most beneficial. Split the manual into chapters or sections that make sense for the product's use, and include a table of contents toward the front of the manual so each section can be found quickly.However, glossaries are not recommended; the best choice is to explain confusing terms in the text of the manual itself. If you choose to include a glossary, place it in front of the manual, just after the table of contents. The general warnings or cautionary information should provide information about potential threats improper use of the product could incur, including death or serious injury. These warnings should be placed in the very front of the manual after the cover page so that the user sees them first. Specific warnings should also be included in the text of the user manual just after or just before a potentially hazardous step is suggested.
Your description should include both a written explanation as to the device’s purpose and a small graphic depicting what the device looks like. The graphic should properly label and name all the switches, knobs, and attachable parts that the device includes.The setup section should include basic information about how to prepare to use the product or device. If the device cannot be constructed or set up by a home user, state this fact plainly in a bold header at the top of the setup section. You should also include:This section is the main portion of the user manual and should provide concrete, detailed information on how to use the device. Begin with basic preparation for using the device, such as plugging it in or washing your hands. Move on to logical, numbered steps that describe how the device should be used, as well as feedback (for instance, “You’ll hear a click.”) the user can expect when using the device appropriately.Some steps are best explained with images as well as words. Think about using photographs or illustrations in your user manual. For instance, you might warn users of a chainsaw not to drink alcohol or use the chainsaw while on certain medications. You could include these videos either at the beginning of this section, or (in the case of videos that illustrate only one step) at the end of each step. The summary should go at the end of the manual, just before the index, in order to provide basic steps of operation. This should be a simplified, stripped-down version of the operational information section, and should be no more than one page. Summarize how to use the device or product. Include basic warnings, numbered step explaining how to use the product, and phone numbers or email addresses that direct users to help.If your device or product requires cleaning, explain how to do so. Be sure to enumerate the cleaning supplies needed. Inform the reader of how often they should clean.
Then, just as you would in any other section of the user manual, include numbered step-by-step instructions as to how cleaning should proceed.For instance, you might say, “Failure to clean will result in a below optimal performance.” If the product or device can be serviced by the user to correct performance issues, include numbered directions as to how the user can do so. For instance, if the batteries need to be changed after every 300 hours of use, include directions on how to check whether the batteries need to be changed, how to remove the dead batteries, and how to insert the new batteries.The user manual should, if necessary, explain how to store the product or device properly. You should also include information about why storage is necessary, and what the results of improper storage are. For instance, you might write:Improper storage could shorten the life of your product due to the buildup of moisture.” You might organize this section as a list of common problems and their solutions. Group similar problems together under a logical heading. This way, users can find specific problems quickly.Before writing a manual for your own product, look at other effective user manuals. Pay attention to the structure, word choice, and sentence style.Read the manuals for similar products that you are selling. For example, if you're selling baby products, read baby manuals, not tech. Standardizing spelling, word choice, and phrasing will make the user manual more user-friendly.Numerically ordered instructions will help the reader stay more focused on the process of using, connecting, or building the product in question.An imperative is an action-oriented verb. By starting each step with a verb, you will clue the reader in to the action required to complete the step.If you’re writing a yo-yo user manual, your audience will be mostly young children. Use simple words and vocabulary in order to explain how the yo-yo works.
If you’re writing a user manual for a scanning electron microscope, your audience will be highly trained scientists who can understand highly detailed information, so don’t shrink from using specialized vocabulary or nuanced explanations.Hire a translator to translate your user manual into the native language of the country that you are shipping your product to. Alternatively, use an online translating app, but ask a native speaker read over and edit the translation for errors.Instead of a few long paragraphs, use many short paragraphs. Look for logical breaks in each section and put useful information into one or two-sentence chunks. The same applies at the sentence level.This won't cause the word-count to go down, but the line breaks will make it easier to read. A manual can lose credibility due to grammar and spelling mistakes. Have a coworker or technical writer edit and proofread the manual as well.This article has been viewed 140,897 times.Next, create safety warnings and write a description of the device. Then, include setup instructions, explain basic operations, and create a product summary to go at the end of the manual. You can also include a section on product care to go over cleaning, basic maintenance, storage, and troubleshooting information. To learn more about the ideal writing style for user manuals, read on! By continuing to use our site, you agree to our cookie policy. Please help us continue to provide you with our trusted how-to guides and videos for free by whitelisting wikiHow on your ad blocker. If you really can’t stand to see another ad again, then please consider supporting our work with a contribution to wikiHow. As an author, your ultimate goal is comprehension—you want readers to easily be able to read, reference, and absorb information. During our adventures creating Dozuki’s standard work instruction software, we’ve come across a few tips and tricks.
It can be helpful to create a written profile of your user, especially when you’re part of a team collaborating on documentation. It may sound obvious, but these are the three basic building blocks to any good user manual. List each section with specific instructions. By breaking information down this way, you make the problems more approachable and easy to follow. If you don't know what something is called, do your best to identify it by looking online or asking someone.The middle of an instruction manual is not it. Taking quality photos doesn’t demand expensive equipment—you can use your smartphone or a simple point and shoot camera. For easy tips on better photos, check out our video on how-to take process photos. Instead, use verbs to convey exactly what you're trying to say. Things like consistent bullet-point styles, image sizes, and text orientation can help make browsing and following along easier for your readers. Looking for a program that makes standardizing instructions easy. Check out how Dozuki does it. However, leave it at that. Most people shudder at the thought of reading a novel before diving into a guide. After all, when's the last time you read the full instruction manual that came with your TV? The reader will be able to identify his or her relative location with greater ease. Most time and money needs to be spent on product development and setting up the sales channels. He knows that there are some legal requirements for the content of the manual and he wants a well designed and user-friendly instructional manual that contributes to a good customer experience. I decided to walk him through the entire process and developed an instruction manual template for him. Here’s what happened. The results are as follows: Although Philip used one of our paid templates, I have made a free template that you can use to achieve exactly the same results. There is only one difference.
We have developed user manual templates for machinery, toys, medical devices and electronics that contain all legal content. I provided him with some general information about user instructions and with some good examples of existing user manuals. A good user manual assists users on how to use a product safely, healthily and effectively. A well-drafted user manual only provides that information that is relevant for the intended user of the product. A good user manual should answer HOW and WHAT questions. They should contain information about what happens if a task is not done correctly. Typical user types are the end-user, installer, maintenance engineer and operator. Each user type needs a different approach in terms of language to be used, the tone of voice and provided conceptual information. A product can be a system, tool, device, an instrument, a piece of software or an app. Depending on the type of product, a user manual might include things as: The template contains all the information and more from the list above. It complies with the requirements for his product. The user manual template is an MS Word document that can be printed or placed online. Each tool has its own advantages and disadvantages. I will mention the most common tools below: Through the following links you can download a user manual sample for documentation: Let’s dive into the details and actions. This can be done by creating a user profile, also named a persona. This is not only useful for creating your user instructions, but it is an essential element at the start of the development of any product. As an educated industrial design engineer, this is how we started all our design assignments. That’s why I asked Philip to define his users and answer questions like: What describes the user? I asked Philip to fill out the template. Please note that the second tab also contains Philip’s answers, so you have an example of how the sheet could be used.
So if you want to take defining your user one step further, I would suggest you visualise your user in the form of a persona. When creating a persona you are giving your user a name, age et cetera, so it becomes a real person that represents your user. This is the result: Typical problems might include: installing the product, using the product, using the product safely, maintaining the product and disposing of the product. In order to do so, I created another template for Philip. In the left column of the Lifecycle tab, the stages of a product’s lifecycle are mentioned. Our user manual templates are compliant with this standard. In other words: Philip has defined the topics for his user manual. Each topic can only be about one specific subject, has an identifiable purpose, and must be able to stand alone. A user wants to solve one problem at a time.It can be a chapter or a (sub-)paragraph. As soon as a user is looking for an answer to his problem, he will use the table of contents to find out how to navigate to that answer. Start numbering PREPARATION PRODUCT FOR USE with number 4. We will add some more chapters in the next step. The ToC is the outline of your user manual.The headings are the (sub-)titles that precede the actual text. They appear in the ToC, so the user can navigate to the needed information. A third-level heading uses noun-phrases (e.g. Packaging contents and Tools to be used ). The heading Making Pancakes is much more user-oriented than Using the MagicCook5000. If the section covers the maintenance and repair of a product, the heading Maintenance would be incomplete. Pro tip: when there is a Declaration of Conformity available already, you can find the applicable directives in there. If the product is too small this can be placed in the user manual. If the product is too small this can be placed in the user manual. Safety information shall be provided in order to inform the user of measures to be taken.
Compliance with harmonised standards provides a presumption of conformity with the corresponding legislation! Without removing and mandatory elements of course. Notice! Do not adjust the Table of Contents. The table of contents can be updated automatically once you have adjusted the section headings. And once you have determined the intended use, you can focus on providing only those safety and user instructions for how to use the product within the given envelope. If the defectiveness of a product needs to be determined, all circumstances will be taken into account. That includes the reasonably foreseeable use of the product. For example, if a cooling system is only used for cooling certain medications, then only these procedures need to be described. When it could reasonably be foreseen that the cooling system may be used as a system to cool organs, this should be described in the instructions. By doing so, you, as the manufacturer, will limit your liability and you can focus on only describing how to use the system to cool medicines. A risk analysis can also be mandatory for certain product groups, such as low-voltage equipment, toys, machinery and equipment for use in explosive atmospheres. The ISO 12100 also gives a method for taking mitigation measures: the Three-Step Method. According to this method, there is the following hierarchy of risk-reducing measures: This is done with safety warnings. The ANSI Z535.6 standard describes the following locations in the user manual where this could be: General text general text general text. 3. Do this. This may also be describing special tools or space for maintenance and repair. These templates contain all legal texts, mandatory disposal information, copyright statements and comply with the IEC 82079 standard on user instructions. Finding the right information that solves the user’s problem should take as little time as possible. We call this version the textual content design.
As Philip has a business partner and a developer with in-depth technical product knowledge, I asked Philip to let them review the work so far. Both his business partner and the developer provided feedback. Philip used this feedback to optimize the user manual. Action: Send the draft version of the user manual to anyone within your team who might be able to deliver feedback. Ask them to combine all feedback into one document before sending it back to you. This stimulates discussion of your team members and prevents disagreement at a later stage. This means that any images can now be created and added to the content. As images should support, replace, or augment text, you want to wait to create them until the texts are final. Often, photos are not as informative because they contain too much information. Besides that, photos can make a user manual look messy. The content needs to be put into the InDesign template. This is called Desktop Publishing. If you decided not to use the InDesign template but stuck to the Word file, then you can skip this step. This could be a translator who is experienced in translating technical content, with similar products or with translating user manuals. Alternatively, you can do this yourself, of course. That can be printed, or used online or on-device. However, as of April 2016, the instructions of many product groups may be delivered in a different format rather than in print. There is one exception, however. Besides that, upon request from a consumer, a paper user manual should be made available to the consumer. Here he can add videos as well. And by optimizing the HTML version for search engines he makes it easier for his user to find information for his user That’s how Philip created a compliant user manual with help from the User Manuals Template and the other available tools that I provided. We have developed user manual templates for machinery, toys, medical devices and electronics that contain all legal content.http://enviedoptique.com/images/bose-acoustimass-25-subwoofer-manual.pdf