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.
Thank you for your response. You're absolutely right, I forgot that key
adjective "functional" before the "specifications".
I have one more question. In your experience, did the manuals describe
procedures (for example, importing a document) or features (for example, the
Tools Menu)?
Jennifer
-----Original Message-----
From: Simon North [mailto:Simon -dot- North -at- synopsys -dot- com]
Sent: lunedi 22 aprile 2002 13.37
To: TECHWR-L
Subject: Re: Software User Guide as Specifications Doc - Anyone tried
it?
Yes, I have successfully worked on a project where the user
guide was used as the interface spec. This was, however, for
a defence equipment manufacturer where the whole culture
was built around specs anyway. Outside of defence systems
I've only rarely encountered an organization that worked
closely enough to specs for the approach to be much use.
You'd also need to be aware that a user guide that like could
only really be considered as a functional spec, and thee are
often quite a few other specs needed as well. If it isn't kept a
s afunctional spec then you run into the well-known problem
of having a manual that describes far too many
implementation details and isn't focused enough on either
tasks, or the readership.
Simon North.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
