Hi Carla, I did this in a manual a few months ago, and I numbered the examples for the same reason you mentioned: if tech support needed to help a customer, they could refer them to an example number rather than trying to explain which one they were talking about.
HTH, Lisa B. On 2/22/07, Martinek, Carla <[EMAIL PROTECTED]> wrote: > > In a software reference guide, would you/do you number examples? > > Specifically, do you number multiple examples under the same topic > heading? Which would be your choice -- Example 1, Example 2, or Example > 3? And here I've answered my own question with *my* preference (ex. 2), > but we have a discussion going on with an SME who insists that he > doesn't want numbered examples at all (ex. 1). I'm just curious as to > what opinion all of you have on this. > > Example 1: > ------------------------------------------------------------------ > Topic > -Example > > Topic > -Example > -Example > -Example > > Topic > -Example > -Example > > ================================= > OR > ================================= > > Example 2: > ------------------------------------------------------------------ > Topic > -Example > > Topic > -Example 1 > -Example 2 > -Example 3 > > Topic > -Example 1 > -Example 2 > > ================================= > OR > ================================= > > Example 3: > ------------------------------------------------------------------ > Topic > -Example 1 > > Topic > -Example 2 > -Example 3 > -Example 4 > > Topic > -Example 5 > -Example 6 > > > ______________________________________________ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. DOCUMENTATION & TRAINING WEST 07: THE USER EXPERIENCE April 18-21, 2007 ~ Vancouver BC ~ Marriott Pinnacle ~ free city tour 40+ sessions * free workshops * free iPod offer * www.doctrain.com _______________________________________________ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
