AW: Putting tips/notes within a numbered list

Subject: AW: Putting tips/notes within a numbered list
From: Ballenberger Gerd <gerd -dot- ballenberger -at- siemens -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 3 Apr 2002 14:39:17 +0200


Nuzhath Shereen is wondering how/where to place tips/notes within a numbered
list:

I would like to know if we can put a tip or a note between 2 sentences of a
numbered list?
For example:
1. do this
2. do that
tip: .....
3. do that

<snip>

Nuzhath, I believe a tip (hint) should go exactly where it's needed, in your
example as part of step 2. And yes, make sure it's indented like other step
2 text so that it's clear it belongs to step 2 and nowhere else.

Caveat: There are scenarios where people dislike (too much) "unnecessary"
text in instructions: "Just give me a 1-page quick guide on how to set up a
worldwide extranet with a couple of relational databases."
To satisfy both worlds, you might use the "layering" technique and "hide"
your tips behind just the word "Tip" or a suitable icon, thus giving
everybody a clue that there is more to read if needed, and at the same time
let quick readers skip it quickly. Not well suited to printed docs, though.

HTH,
Gerd

gerd -dot- ballenberger -at- siemens -dot- com
Erlangen, Germany




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



Follow-Ups:

Previous by Author: RE: Best Practise
Next by Author: RE: names for doc statuses
Previous by Thread: RE: Multi lingual Online Help
Next by Thread: RE: Putting tips/notes within a numbered list


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


Sponsored Ads