RE: Doc Design and Convention ( was TECHWR-L Digest, Vol 48, Issue 27)

Subject: RE: Doc Design and Convention ( was TECHWR-L Digest, Vol 48, Issue 27)
From: Paul Hanson <phanson -at- Quintrex -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 3 Nov 2009 12:03:41 -0600

Hanging on my cubicle wall:
|
When documenting something, you must answer the five golden questions:
1) What is it?
2) What does it do?
3) What is its purpose?
4) How does it work (or how does it do what it is supposed to do)?
5) Why is it relevant?
|
Thought that'd be helpful.


Paul Hanson
Technical Writer
Quintrex Data Systems http://www.quintrex.com
email: phanson at quintrex.com




-----Original Message-----
From: Julie Stickler
<snip>
I've seen narratives that went on for pages and pages without a break, describing everything you could possibly do on a screen, without ever once telling you WHY you'd want to do them.
<snip>

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:
http://www.doctohelp.com/

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
Re: Doc Design and Convention ( was TECHWR-L Digest, Vol 48, Issue 27): From: Chris Despopoulos
Re: Doc Design and Convention ( was TECHWR-L Digest, Vol 48, Issue 27): From: Julie Stickler

Previous by Author: Re: HTML Help Workshop question
Next by Author: Code Annotation in HTML pages
Previous by Thread: Re: Doc Design and Convention ( was TECHWR-L Digest, Vol 48, Issue 27)
Next by Thread: Re: Doc Design and Convention ( was TECHWR-L Digest, Vol 48, Issue 27)


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

Sponsored Ads


Sponsored Ads