How to write documents for SaaS web applications

SaaS and web-based applications are becoming more popular as they replace desktop or network installations. How you document them is mostly the same as documenting traditional but there are some difference. Let’s take a look. Registration – explain how to set up the account, register an account, common setup issues, and troubleshooting, for example, if […]

Sample Guidelines for Writing Online Help

If you’re looking for guidelines to write your online help documentation, then use this checklist to get started.

Does your writing have an accent?

Maybe you don’t hear your accent, but others do. When you read their documents, does the accent come through?

Do CEOs Need to Write Well to Succeed?

Thom Haller asks on TCW if ‘to be an effective leader, you need to learn how to write well’.

10 Best Mistakes I Made in 2009

Fail to prepare, prepare to fail. If you don’t know your mistakes you’re going to repeat them. Here’s my best mistakes.

How do you measure the value of technical documents?

One of our tech docs team was fired yesterday. Why? Technical documents provide no value. This is how Management sees it. Tech docs are nice to have but NOT essential. Tech docs are useful but LESS important than development, user interface and marketing. Are they right? It’s hard not to get defensive in these situations. […]

Are technical documents a waste of time?

“Don’t worry” she said. “No one reads this stuff anyway. Just get it done.” Sounds familiar? These were the words a former Project Manager once told me. I’d written 20,000 words for a banking system – and no-one would read it. What do you do when your own company has such a poor view of […]

How to Write a Target Audience Questionnaire

Creating a training plan? Before you do this, you need to step a step back and work out what your colleagues need to learn.

How to change 100 screenshots with a single click

All the screenshots in your Word document are different sizes. What’s the quickest way to get them all the same size? Is there a shortcut? Yes!

How To Manage Negative Comments on your Blog

I need your advice. Someone has left a fairly negative comment on my blog. What should I do? Approve or Delete?