OVERVIEW
Most product documentation sounds love their product is the alone object in the User’s activity. Such thinking results in User confusion and dissatisfaction. This article presents three real-life examples of this mind, and what should be done to remedy these unlucky situations. The article concludes with some techniques for the writer.
BACKGROUND
There are two valuable information [...]
OVERVIEW
To actualize an able User File, the writer must understand who he/she is writing for. This article presents four size (Skills, Mind, Experience and Familiarity) for describing the User of your product (your Documentation Reader), and how to make a Persona that turns your generic User into an almost-real man. The article stresses the charge [...]
Overview
Our humdrum, sterile headings and writing process accomplish small to animate our Users to glance at parts of the product documentation that would be exceptionally benign for them. This article presents two real-world examples, how they fail their users, and how to right the problems.
Not the Legal & Disclaimers
Although the Legal and Disclaimer sections of [...]
OVERVIEW
You’re a non-writer who has aloof been assigned to address the User Documentation for your corporation’s fresh product. Your overwhelming feeling is abhorrence, maybe with some acrimony.
With any fresh life there will be some anxiety. Writing may accept added anxiety as of your writing familiarity while you were a student.
Writing User Documentation is not love [...]
OVERVIEW
Searches in User Documents (manuals, etc.) generally fail as the Reader uses altered text for a idea than the author uses. Because the Reader’s text accomplish not arise in the file, the file search mechanism cannot acquisition them, resulting in frustration. This article describes a User-friendly method for improving searches, without having to chicken [...]
OVERVIEW
Point confusing your Reader with the text you employ. Your Reader is trying his/her top to accept how your product works without having to figure outside your writing. Here are some writing guidelines to advice you point baffling your Reader.
Identical Idea: Identical Text
User Documents are not meant to be entertaining. Accomplish not best shot to [...]
Overview
Incomplete User Documents disappoint your Readers. Two attitudes of abounding Mechanical Writers aftereffect in incomplete User Documents. These two attitudes are:
. “Everyone Knows That”, and
. “The User Can Figure It Outside”
This article describes these attitudes and presents methods for overcoming them. The aftereffect is added able User Documents and added satisfied Users.
1. “Everyone Knows That”
The [...]
OVERVIEW
Abounding organizations make in-house tools or change commercially-available tools for their own employ. These tools should amuse documented so they are of employ to others in the group.
Provided this documentation is not created or is poorly written, it costs you twice:
* The aboriginal price (attributed to any bad user file) is the price of [...]
Provided you accept abundant love for text and accept a measure or diploma in any technology world, then your chances of accomplishment is beyond your wildest imaginations. You can be thing of that clan of writers outside there, who accomplish anything from a thousand dollars to distinct thousands every month from writing mechanical articles online [...]
OVERVIEW
Bodies are visual creatures. They attending at your product, and look, for archetype, a button or affectation. They desire to acquisition outside approximately that ascendancy or indicator. A Visual Index is a child’s play however able file access thing that enables your Readers to acquisition the advice that they desire.
This article describes the Visual Index [...]
