RE: paper documentation vs. online help

Subject: RE: paper documentation vs. online help
From: quills -at- airmail -dot- net
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 18 Apr 2002 12:04:35 -0500


At 11:02 AM -0400 4/18/02, MacKenzie, Colleen wrote:



What about layering information in online Help systems? In this structure, reference & conceptual information (and other material not immediately needed for task execution) is linked to relevant procedures, but is not in-your-face (thus, taking up real estate or making the user hunt for the kernel).

Colleen

Colleen,

With XML, or SGML based documents you could do that more easily than in normal WinHelp systems. The delivery is much more difficult since the delivery is dependent upon your intent, which can be placed into the coding. The transformation of the information would be based upon how you access the information, e.g. through context sensitive hooks from a program, through an entry point from a browser, or through a query engine. Or through something else that might be cooked up.

The content isn't the problem. The problem is delivery, context, and intent of the viewer.

If a tech writer were to write the content and tag it with XML for delivery based upon attributes (context or intent) then you could write and provide all the documentation complete with a program. There are no tools to assist in the workflow, especially the editing and comprehension of such an effort. Doesn't mean it couldn't be done. Just that no one has done it and marketed the tools.

Scott


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr

Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.


References:
RE: paper documentation vs. online help: From: MacKenzie, Colleen

Previous by Author: RE: paper documentation vs. online help
Next by Author: Re: Tech Writing Question
Previous by Thread: RE: paper documentation vs. online help
Next by Thread: Hello


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


Sponsored Ads