Re: Penguins?

Subject: Re: Penguins?
From: Stuart Burnfield <slb -at- westnet -dot- com -dot- au>
To: Techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 1 Nov 2011 13:18:46 +0800 (WST)

Hi Becca -

Gene said:
> If time and budget permits, I would create the content. For
> documents being delivered in online formats, you can make it
> accessible by links. For printed documents, you can use sidebars
> readers can ignore if they don't need the extra information.

I like this better than the suggestion to put the information in an appendix, which would work better for dry, formal, technical information. You want to flag this information as not necessary, but maybe interesting, maybe useful. Sidebars are excellent for that.

Each sidebar should be just long enough to answer the basic questions: What is it? Why is it relevant to my ebook? Where can I find out more?

For XHTML, the answer to 'why is it relevant' could be that it might help troubleshoot and fix problems. For CSS, you might say that knowing CSS would enable them to change the default layout or branding.


Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.

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
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at

Previous by Author: Re: STC Certification
Next by Author: Annotated outlines...
Previous by Thread: Re: Penguins?
Next by Thread: Paper Specifications

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

Sponsored Ads