RE: When is it too much information?

Subject: RE: When is it too much information?
From: Stuart Burnfield <slb -at- westnet -dot- com -dot- au>
To: Techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 19 Feb 2013 13:59:04 +0800 (WST)

Craig said:
> Another question I'm always asking myself is, when is it
> too much information for one topic?
>
> When should a topic that is chock full of goodies be split
> into two topics?

When you're mixing a substantial amount of information of different types (concept, reference, task, troubleshooting, ...). When writing a procedure it's tempting to lump in a lot of conceptual stuff "just in case they don't know that - it would be handy to say it here". The main thread of the task gets lost under all the digressions. It's better to explain the terms and background concepts elsewhere, and provide 'related topics' links at the end of the procedure.

It's like giving visitors directions to go shopping - just tell them how to get there. Alternate routes, traffic reports, local history and nearby tourist hotspots might all be interesting and useful, but it's better to give them that information in another form when it's needed.

Stuart
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
EPUB Webinar: Join STC Vice President Nicky Bleiel as she discusses tips for creating EPUB, the file format used for e-readers, tablets, smartphones, and more.

Learn more: http://bit.ly/12LyN2z

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

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


Previous by Author: Re: scroogled?
Next by Author: Re: Deprecated (was When is it too much information?)
Previous by Thread: Re: When is it too much information?
Next by Thread: RE: When is it too much information?


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

Sponsored Ads


Sponsored Ads