Re(2): Software User Guide as Specifications Doc - Anyone tried it?

Subject: Re(2): Software User Guide as Specifications Doc - Anyone tried it?
From: Jan Henning <henning -at- r-l -dot- de>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 22 Apr 2002 14:34:24 +0200


>There are essentially two approaches that we can adopt while writing a User
>Guide.
>
>[...]
>
>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.

These two approaches are not mutually exclusive. It is entirely possible
to use both within the same documentation, resulting in a task-oriented
section and a reference section.

Regards
Jan Henning

--------------------------------------------------------------------
Jan Henning
ROSEMANN & LAURIDSEN GMBH
Am Schlossberg 14, D-82547 Eurasburg, Germany

Phone: +49 700 0200 0700, Fax: +49 81 79 93 07 12
E-Mail: henning -at- r-l -dot- de, Web: www.r-l.de
Handelsregister: München HRB 99345
--------------------------------------------------------------------


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

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

---
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: Software User Guide as Specifications Doc - Anyone tried it?: From: Badrinarayanan_Srinivasan

Previous by Author: Re(2): Font Selection Methodology
Next by Author: Re: lurkers and lurking
Previous by Thread: RE: Software User Guide as Specifications Doc - Anyone tried it?
Next by Thread: RE: Software User Guide as Specifications Doc - Anyone tried it?


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


Sponsored Ads