- Writing A User Manual David Hewson Pdf Page
- Writing A User Manual David Hewson Pdf File
- Writing A User Manual David Hewson Pdf Online
- Writing A User Manual David Hewson Pdf Download
Contents
Know who you are writing for
Download the functional art free download epub or read online books in PDF, EPUB, Tuebl, and Mobi Format. Click Download or Read Online button to get the functional art free download epub book now. This site is like a library, Use search box in the widget to get ebook that you want. Writing A User Manual. I’ve just finished reading Writing: A User Manual by David Hewson. Unlike many other writing books, Hewson doesn’t say, “These are the rules to writing,” instead he says, “This is how I do it.”If you’ve ever considered writing a novel, then I’d certainly recommend reading it. Writing User Manuals: Get Someone Else To Do It (Seriously!) Just because you've created an application, it may not need a user manual, guide or help system. And, even when your application does need that kind of support, you should - at all costs - avoid writing it. By Peter Vogel. Find helpful customer reviews and review ratings for Writing: A User Manual: A Practical Guide to Planning, Starting and Finishing a Novel by David Hewson (2012-02-16) at Amazon.com. Read honest and unbiased product reviews from our users. Aug 21, 2016 Writing: A User Manual: A practical guide to planning, starting and finishing a novel - Kindle edition by David Hewson. Download it once and read it on your Kindle device, PC, phones or tablets. Use features like bookmarks, note taking and highlighting while reading Writing: A User Manual: A practical guide to planning, starting and finishing a novel.
Writing A User Manual David Hewson Pdf Page
Amazon review, Writing: A User Manual ‘It’s finishing the book that counts’ As a prolific writer, David has been in demand for writing tuition classes all over the world. But time constraints mean that these days his advice is largely confined to blogs on this site and his occasional books on writing.
If you know who your target group is, you know two very important things that are necessary to write a high-quality user manual.
Writing A User Manual David Hewson Pdf File
Writing A User Manual David Hewson Pdf Online
First, you know something about the tone of voice. If you are writing a user manual for first-time users of an alarm system, it could be that you need to explain how to set up the sensors in a room. You should motivate them to have a look at several examples so that users can use the sensors effectively. This requires setting up some kind of motivational relationship with the reader so that he/she gets the most out of your product.
However, if your product does not need an introduction because users will be familiar with it right from the start, you could leave out examples or any advice to experiment. Your language could be more business-like, just pointing out where the relevant buttons are.
The second consideration aligns pretty well with the first point made. Any target group values its own level of detail. It is not necessary to explain to maintenance personnel how to clean a manufacturing machine. People from this group would be offended if you would spell out what to do. However, it is necessary to tell personnel from a small company how to replace printer cartridges. Or to inform them when a printer would need internal cleaning.
It is always important to keep in mind who you are writing for.
A good start is your Table of Contents
Why is a Table of Contents a good start? Because a Table of Contents forces the writer of a user manual to think about what he/she wants to say in what order. Of course, there will be a foreword or an introduction in any user manual. Without doubt, there will be safety instructions at the beginning of the manual as well. There will also be some maintenance issues at the end. But what should you put in between those chapters?
Writing A User Manual David Hewson Pdf Download
This all depends on the product itself. For some products the settings are important: one day a pump may work ‘normally’, another day it may be best to set it in reverse. This could depend on water levels, for example. A chapter called “Everyday settings” could be appropriate here. Another chapter may be about collecting information how much water has been transported and to where exactly. One could call such a chapter “Monitoring results”.
Take another example: a so-called ‘multifunctional device’. For a ‘multifunctional’ the chapters in a Table of Contents could be based on, indeed, its different functions: printing, copying, scanning, faxing, and so on.
As long as there is some logical order that the user can relate to, the user manual lends itself for effective scanning. In this respect, it is absolutely essential that each chapter and each paragraph has a clear-cut title: “Printing using your computer”, “Copying without your computer”, “Scanning to your computer” and so on.
Collect all necessary information
A technical writer has the reputation of being inward looking, interested as he/she is in only one thing: technology.
This reputation does not do him or her justice. A technical writer should know a lot about voltage, current, resistance and megahertz. But he should also know how to collect all the necessary information. Quite a lot information may be available on paper or digitally. One could think of a risk analysis, 3D CAD illustrations, data sheets and so on.
But it is quite possible, even probable, that this information does not answer all the questions a technical writer has in mind. After all, a technical writer wants to place himself in the shoes of the user. If the documentation does not elaborate on the need for a pump to be set in reverse, he needs to ask the experts: why is it necessary to set this specific pump in reverse?
This means a technical writer has to have communication skills. He also has to have social skills. Placing yourself in the shoes of another person has everything to do with wanting to know the other person.
Portraying a technical writer as a ‘technician only’ would be a mistake. It takes more to write a user manual than being ‘tech savvy’.
Actually writing (illustrating?) your user manual
OK, you have collected all necessary information. Now it is time to actually write your user manual. Three considerations spring to mind.
The first consideration has to do with minimalism. Minimalism is a philosophy not to spend more words on a subject or task than is strictly necessary. It is not necessary to tell the reader that a valve is available in three colors when the only valve on a tank is red. A user only needs to know how to use the valve and when. This may sound very obvious, but proves to be quite a challenge in (too) many cases. Some companies do not throw away their ‘marketing head’ easily.
Canon powershot elph 150 is manual. View and Download Canon PowerShot ELPH 150 IS IXUS 155 user manual online. PowerShot ELPH 150 IS IXUS 155 Digital Camera pdf manual download. Also for: Powershot elph 135 ixus 145, Powershot elph 140 is, Powershot elph 135, Ixus 155, Ixus 150, Ixus 145. The slim, stylish Canon PowerShot ELPH 150 IS equipped with a 10x (24-240mm) optical zoom lens suitable for wide range of shooting situations. The 20 MP CCD sensor combined with the DIGIC 4+ Image Processor captures superb images with incredibly clear and beautifully detailed, that are perfect for large-scale prints or creative cropping. View and Download Canon PowerShot SX150 IS user manual online. PowerShot SX150 IS. PowerShot SX150 IS Digital Camera pdf manual download. CANON SEE IMPOSSIBLE × Canon See Impossible Home; Create Your Vision. Camera User Manual. EOS 5D Mark II. EOS 5D Mark III. EOS 5D Mark IV. EOS 5D Mark IV with Canon Log. PowerShot ELPH 150 IS. PowerShot ELPH 160. PowerShot ELPH 170 IS. PowerShot ELPH 180 IS.
The second consideration is: always use Simplified Technical English if you want to be business-like. Simplified Technical English, or STE for short, does away with words that are ambiguous, such as ‘to carry out’. ‘To carry out’ could mean ‘taking something away from a certain location’, but also ‘taking action’. In STE, only the verb ‘to do’ will do. Also, STE limits the number of words in a sentence to roughly 20. This make any sentence easy to understand.
The third consideration is also very important. Why use text if an illustration works just as well or even better? After all, an illustration takes away the need to translate text. But even more important is the fact that people are first and foremost visually oriented. The saying ‘A picture tells you more than a 1,000 words’ implies that people grasp the meaning of something faster and better when it is illustrated. You cannot present all information visually (“Be sure the holes are free of wood chips and saw dust”). But where you can, the benefits for the user can be enormous. Thus, ‘writing a user manual’ takes on a whole new meaning.
Choosing the appropriate format
There still is one choice left: what kind of layout do you want? Or, in jargon: what is the template you want to define so that your user manual not only matches the wishes of the user, but also your corportate identity? Consistency is key here: every chapter and every paragraph should look the same.
There are software tools available that help you to define a professional template. What’s more: there are content management systems on the market that can transform a single source text into any format required, whether this format would be an A5 booklet, an A4 book, a PDF file (portrait or landscape) or a website that adjusts itself automatically when presented on a computer or tablet or smartphone.
Companies that are specialized in writing user manuals know how to help you choosing the relevant formats – in case you would need advice.
In your day-to-day work, you might find that there are times when you need to provide a client with documentation that walks them through a process or teaches them how to do something they may be unfamiliar with.
I’ve mentioned before that I view writing skills as vitally important for everyone, in every business, and this is a prime example of why being able to write effectively is so important. If you can’t get the steps and details down on paper in an easy to understand and intuitive way, you will probably spend a great amount of time and frustration handling support requests and fixing things done incorrectly.
Here are seven tips to help you create a comprehensive yet coherent instruction manual.
- Get out of your own head: When you begin to prepare instructions for processes you know inside and out, you will need to consciously take a step back and approach the material from a new angle. Start at square one by assuming the audience will have zero knowledge of the subject matter.
- Know the objective: Make sure you know exactly what your manual needs to cover in order to avoid information overload or confusion that can come from too many details. This is especially important when the process is complex or has a lot of different parts.
- Outline it first: Before jumping in and creating steps, create a high-level outline of what the document will cover, including main and subsections. This will help you make sure your process makes sense and that each section of the manual is consistently structured.
- Make it easy to understand: Lists are a great way to outline steps for doing something because they can help people move item by item in the way you intend. It’s also a good idea to use a table of contents and make your document searchable, if possible, to further support your step-by-step approach.
- Be brief: It’s tempting to want to explain everything in fine detail since it’s material you know so well, but stick with only what the recipient needs to know. Focus on using only as many words as necessary to get your point across.
- Use visual aids: Screenshots, diagrams and even videos are a great way to beef up your manual and make it easier to understand. Keep the formatting of these supporting materials consistent and to the point to avoid overwhelming the reader.
- Give it a test drive: Or better yet, have someone else who has never seen the material before run through the instructions. Take their feedback and use it to fine tune your manual.
Keep in mind that you may need to review and update the manual periodically, especially if it’s something that focuses on a third-party application or other system you do not control. Plus, with some material, it may also make sense to offer the client a hands-on walk through to ensure your instructions accomplish what they need to accomplish. And keep in mind that learning styles vary, so one client may be able to run with the same instructions that confuse a different client. Being flexible in your format and delivery can help make sure the instructions work for the recipient.
Do you ever provide clients with written instructions? What advice do you have?
Image credit: svilen001