Re: What information needs to be in a Technical Manual?

Subject: Re: What information needs to be in a Technical Manual?
From: Andrew Plato <gilliankitty -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 7 Jul 2004 09:30:03 -0700 (PDT)

"Nadine Underwood" <> wrote ...

> I have been tasked with creating a Technical Manual for a web hosted
> application. All of my experience is in User Guides / System Admin
> Guides etc. I have little experience, if any, in writing technical
> documentation for technical users. Does anyone have any pointers on the
> topics it should contain etc etc. Any guidance would be gratefully
> received.

You need to Answer the 5 Golden Questions about the product you're documenting:

What is this?
What is its purpose?
Why is designed this way?
Where are the dependencies?
How does it work?

Work on having complete answers for those questions. Then you'll be prepared to
write the manual. You won't need help on the topics, they'll be obvious.

Andrew Plato

Do you Yahoo!?
Read only the mail you want - Yahoo! Mail SpamGuard.


ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!

COMPONENTONE DOC-TO-HELP 7 PROFESSIONAL: From a single set of Word documents, create online Help and printed documentation. New version offers yearly subscription service, Natural Search, Modular TOC Utility, Image Map Editor, Theme Designer, Context String Editor, plus more. .

You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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 for more resources and info.

Previous by Author: Re: Denver Contracting
Next by Author: Re: Deadline extended for proposals for STC Annual Conference
Previous by Thread: Re: What information needs to be in a Technical Manual?
Next by Thread: Distiller 6.0 Question

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

Sponsored Ads