RE: Website Documentation Procedures - Educating an Employer

Subject: RE: Website Documentation Procedures - Educating an Employer
From: Paul Hanson <phanson -at- Quintrex -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 29 Aug 2008 12:12:37 -0500


You should be involved in the design of the website. You should contribute helper text and embedded user assistance (UA) so that the user interface (UI) is designed so that there is no need for online Help in the standard 'open a new window to read the help text' type of thing. Embedded UA is the way to go. Think about the fairly common things you may do online: buy a ticket for a WWE event, buy flowers for your significant other, or reserve a hotel room. How many times, during those tasks, did you see information you needed within the context of the fields you had to fill out? For example, when I went to buy a Ticketmaster ticket for Memphis in May in 2007, all the stuff I needed to know was there.

This is not a new idea if you've been to any of Scott DeLoach's presentations @ a WinWriters conference. Here's a link: to an overview of the approach. Here's a direct link to another presentation:

Additionally, look through Jared Spool's website. He may have some info re: this. I'd look but I'm cramming 12 weeks of doc changes into today and Tue-Friday next week.

Paul Hanson
Technical Writer
RoboHelp ACE -
Quintrex Data Systems
email: phanson at

-----Original Message-----
From: techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Collin Turner
Sent: Friday, August 29, 2008 11:21 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Website Documentation Procedures - Educating an Employer

Not that I hope to change anything...

I need to provide some solid 3rd party (preferably "official") documentation
procedures for providing documentation for websites. Specifically pre-launch
- at what point during the Dev cycle should the documentation be created,
reviewed, etc. Standard procedure for the Industry.

Anybody have some useful sources?




ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.


Website Documentation Procedures - Educating an Employer: From: Collin Turner

Previous by Author: RE: Moving to Word 2007
Next by Author: RE: MS Help Workshop V1.0 HHC3004 error message
Previous by Thread: Website Documentation Procedures - Educating an Employer
Next by Thread: Re: Website Documentation Procedures - Educating an Employer

What this post helpful? Share it with friends and colleagues:

Sponsored Ads