RE: Business issues, documentation and editors

Subject: RE: Business issues, documentation and editors
From: "Damien Braniff" <DBraniff -at- amphion -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 11 Jan 2002 08:04:22 -0000

Why I fell that most users accessthe online help to find out HOW to do
something, I am assuming that they already possess some basic
understanding of the software. This isn't always the case and I feel
that some background (What/Why) is also needed. Generally I do this by:

Having an introductory sentence - this screen allows you to...
or something similar.
Follow this with the 'how to' information
Use 'See Also' to point to background topics (What/Why/etc)
Use 'Related Topics' to point to related 'How to' topics

Damien Braniff
Technical Writer
Amphion Semiconductor Ltd.
50/51 Malone Road
BT9 5BS Belfast, Antrim
Northern Ireland

Tel: 028 9050 4000
Fax: 028 9050 4001
E-mail: dbraniff -at- amphion -dot- com
Web: www.amphion.com




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

---
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.


Previous by Author: Re: Using a gerund phrase for procedure topic title --vs. infinitives and root forms of the verb
Next by Author: RE: A cautionary tale
Previous by Thread: RE: Business issues, documentation and editors
Next by Thread: Re: Business issues, documentation and editors


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


Sponsored Ads