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.
A great question, and one that boils down to the essential TechCom rule #1:
Know Your Audience.
This saves you from having to reinvent the wheel, create new mental
models, and otherwise go paycho trying to figure out the right amount
of information to provide.
Identify your target audience and what they already know. Then speak to that.
It's easier to shift one's thinking when you base it on concepts that
are already familiar.
Don't worry: it's hard to get this perfect, even for the experiences writers.
-Tony
On 2011-10-30, at 1:09 PM, Becca <becca_price -at- yahoo -dot- com> wrote:
> There's an old joke about a little kid who started out a book report "This book tells me more about penguins than I really wanted to know."
>
> In a document talking about how to create ebooks without knowing CSS and XHTML, is it too much to have brief digressions on what CSS and XHTML mean, and why they're important in ebooks? What about a discussion of ereaders, with a section on aspect ratios of screens (which can affect how graphics display)?
>
> -becca, who has been working on this project for far too long now and has lost all sense of proportion.
>
>
>
> =========================
> There are nine and sixty ways of constructing tribal lays
> And every single one of them is right!
> --Rudyard Kipling
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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 tonyc -at- tonychung -dot- ca -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/tonyc%40tonychung.ca
>
>
> 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
>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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
