TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
> 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. http://www.doctohelp.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-