First things first

I’m in the midst of interviewing to fill a vacancy for a technical writer in our team. I’m also thinking ahead as to how to get them integrated into how we do things. And then I remembered what we have done previously.

“Hello, welcome to our wonderful company. Here is a copy of the software, and the installation guide. Go!”

OK, it’s not quite like that but it is a good opportunity to check over a part of the documentation that is crucial but can be neglected.

Product installations come in all shapes and sizes, from those simple wizard driven screens to systems which require all manner of pre-configured and pre-installed supporting applications. The latter can be the trickiest as often there is a myriad of possible, valid, scenarios, and can lead to a lot of presumption.

Regardless, the installation is the first time the real users get to get their hands on your product and so it’s a good place to get reviewed by the closest person you’ll have to a new customer. A new member of your team.

One Comment

  1. Kai said:

    Right on, Gordon! I hardly know a more beneficial win-win situation than to bring a new doc colleague up to speed by asking him or her to use (and review!) existing documentation.

    May 11, 2010

Comments are closed.