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
Even though this is an advanced-level user reference guide, we still get
calls to TechSupport for help on it. I feel it is easier to refer to an
example number on a page instead of making the user count or read the
examples to find a specific one.
The one example on my desk with examples in it uses compound numbering,
and restarts for each new chapter (1-1, 1-2, 2-1, etc.)
-Carla
- CONFIDENTIAL-
This email and any files transmitted with it are confidential, and may also be
legally privileged. If you are not the intended recipient, you may not review,
use, copy, or distribute this message. If you receive this email in error,
please notify the sender immediately by reply email and then delete this email.
______________________________________________
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
