Playing games trying to decipher cryptic passages and discovering hidden keys can be fun. Doing the same trying to master a technology to get the job done… not so much. Regrettably, however, this is too often the norm in the tech world. Is it because we developers are too interested in creating the “bells and whistles” to bother with communicating how to use them? If you’re looking for an example, look no further than the training provided for customizing iNotes: a one hour video with an emphatic “Damn, I finally got that off my plate” (well, that’s what I would have said after making it - no offense intended to the guy saddled with the job).

If companies can’t invest the time and resources to provide top flight training materials for their software, then they have no business creating those products in the first place. We waste way too much time trying to figure out how to make things work in the absence of clear and direct instructions and communication.

Here following is what I consider the criteria for top flight training materials…

A holistic approach. A guide should be the central point of reference encompassing all, systematically building understanding and serving as an ongoing reference and reminder. Videos demonstrate what the various mechanisms look like in operation to the end-user as well as how to put them in place. Downloadable applications provide hands-on experience in using those mechanisms.

A consistent presentation. Every section of the guide should be structured identically wherever possible, something along the lines of the following:

• Purpose – a concise description of what the section is about
• What it looks like – typically what the end-user sees in operation
• How to make it happen – an illustration of the components behind the displayed functionality
• Additional notes and references – where to go for additional information, referencing the associated video and application

The same holds true for instructional videos. First tell me why this should interest me, secondly demonstrate the final result and lastly show me step by step how it is we get there. How many videos have I seen where it’s only at the end I see that what’s being demonstrated isn’t what I’m looking for!

One concept, one page. Everything regarding the given topic should be put right in front of you. Don’t drivel the concept over a half-dozen. If a concept can’t be communicated on one page, it hasn’t been sufficiently thought through. Break it down into components with hyperlinks to click on to get more detailed information (with another click to get back to where you were in the document).

Display interrelationships graphically. If there are components that are connected, show it to me in a graphic with lines connecting the dots. A picture is worth a thousand words.

Well, that’s it. I would just add that if you can get all this in a software, you: 1) have a very mature product; and 2) will be up to speed using it in no time at all.