Articles

19/012015

Identify Your Audience

Before you start writing, even before you think about content, format and technical details, you must first identify your audience. Your typical users While you can’t imagine every reader who may eventually pick up your manual or consult your online support, you can profile your ideal or typical user, a kind of avatar who summarizes […]

09/122014

Myth 5: Technical Documentation Is Useless

Just use the product. Push a few buttons. Shake, shake. Kick! Okay, it’s still not working. Make a few phone calls. You’ll figure it out! Right? Hmm… Actually, a user’s manual might be handy right about now.   Reality Think of when you’ve ever been in a pinch: a deadline is looming, your staff is […]

25/112014

Myth 4: Technical Documentation Should Be an Inside Job

Many managers think that because their staff knows their products like the back of its hand, documentation is best produced in-house. Reality Contrary to what some may think, outsourcing your technical documentation may be a better choice since knowing your product is only part of producing quality documentation. While it’s true that your in-house staff […]

11/112014

Myth 3: Technical documentation? Boring!

For many people, technical documentation is uninteresting because of all the dry facts and information it presents. Reality Okay, it might be true that technical documentation rarely has exciting information: there is no action and definitely no suspense. While your documentation may never be nail-biting and breathtaking, you can most certainly make it interesting! No […]

28/102014

Myth 2: Technical Documentation Is Expensive

Legend would have it that technical documentation is frightfully expensive, devouring your budget in one toothy bite. Technical documentation projects are spooky expenditures that haunt your company like skeletons in the closet… Aren’t they? Reality Though all too rare, cost-benefit analyses prove that technical documentation is not only affordable, it’s sweet and profitable when well […]

14/102014

Myth 1: Nobody Reads Technical Documentation

Your clients don’t consult your technical documentation? They’d rather work it out “the hard way,” even if it means making a few mistakes and wasting some time, before they resort to opening your user guide? We provide you with a few tips and tricks to make sure your client not only reads but enjoys using […]