TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
There are essentially two approaches that we can adopt while writing a User
Guide.
The Functional Approach is a product oriented method where you describe in
detail every feature that the application has. You could describe the menus,
the fields, the buttons and what have you. You start with the product, list
down all its features and explain those.
The Task-oriented Approach on the other hand is a much better way, where you
have the user as a focal point. You start with the user, consider the
various tasks that he has to do and then produce your User Guide based on
the sequence in which the user is going to go about the application.
The "features" you speak of are going to be used anyway in the "procedures."
The best bet therefore would be to start with the procedures and have the
features explained as you go along.
Hope this helps.
Have a nice day,
Regards
-------------------------
Badri Narayanan
Satyam Computer Services Limited,
Chennai
India
Ph: 8206120
Extn: 5812
You live and learn...and I have learnt to express no opinion but mine.
**************************************************************************
This email (including any attachments) is intended for the sole use of the
intended recipient/s and may contain material that is CONFIDENTIAL AND
PRIVATE COMPANY INFORMATION. Any review or reliance by others or copying or
distribution or forwarding of any or all of the contents in this message is
STRICTLY PROHIBITED. If you are not the intended recipient, please contact
the sender by email and delete all copies; your cooperation in this regard
is appreciated.
**************************************************************************
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
