Re: TOCs in Reference Manuals:pros and cons

Subject: Re: TOCs in Reference Manuals:pros and cons
From: Lin Sims <ljsims -dot- ml -at- gmail -dot- com>
To: "Cardimon, Craig" <ccardimon -at- m-s-g -dot- com>
Date: Fri, 6 Sep 2013 16:08:40 -0400

Definitely. Unless it's INCREDIBLY SHORT with really BIG headings, they'll
need at least a TOC to find stuff. And if you have tables or diagrams that
can be referenced without needing to read the surrounding text, then lists
of tables and figures are good, too.


On Fri, Sep 6, 2013 at 3:40 PM, Cardimon, Craig <ccardimon -at- m-s-g -dot- com> wrote:

> I would say yes. A technical manual without a TOC is like a skeleton
> without a backbone.
>
> -----Original Message-----
> From: techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com [mailto:
> techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of
> Matt Gras
> Sent: Friday, September 06, 2013 3:40 PM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: TOCs in Reference Manuals:pros and cons
>
> Thoughts, please, about whether a TOC is useful in a technical reference
> manual (for an electronics board sold to engineering students).
>
>
> thanks,
> Matt
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> New! Doc-to-Help 2013 features the industry's first HTML5 editor for
> authoring.
>
> Learn more: http://bit.ly/ZeOZeQ
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as ccardimon -at- m-s-g -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
> Information contained in this e-mail transmission is privileged and
> confidential. If you are not the intended recipient of this email, do not
> read, distribute or reproduce this transmission (including any
> attachments). If you have received this e-mail in error, please immediately
> notify the sender by telephone or email reply.
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> New! Doc-to-Help 2013 features the industry's first HTML5 editor for
> authoring.
>
> Learn more: http://bit.ly/ZeOZeQ
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as ljsims -dot- ml -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>



--
Lin Sims


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

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

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-leave -at- lists -dot- techwr-l -dot- com


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

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
TOCs in Reference Manuals:pros and cons: From: Matt Gras
RE: TOCs in Reference Manuals:pros and cons: From: Cardimon, Craig

Previous by Author: Re: Chapters must start on recto page???
Next by Author: RE: Chapters must start on recto page???
Previous by Thread: RE: TOCs in Reference Manuals:pros and cons
Next by Thread: TechWhirl Community Forums: The Journey Continues


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

Sponsored Ads


Sponsored Ads