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.
Coincidentally, I am in a similar position. I have written a series of
tutorials to accompany a series of demos for our product, also aimed at
developers (mostly Java, we expect). I inherited a series of 7 demos, each
explaining one concept or demonstrating one function or feature of the
product. I trashed the simplest one, because it was insultingly simple, and
left the rest as is.
It just seemed logical to me to have a one-to-one (more or less)
relationship between concept/feature and demonstration. Users who say,
didn't require the simpler demos could just skip ahead to the more
complicated ones. Or, alternately, if there were features a user didn't
understand, he could just refer to the demo (the user guide regularly refers
to the pertinent demos). Perhaps the level of sophistication of the concepts
we're explaining differs...that is, two or three of your concepts may be as
manageable as one of mine (That sounds a bit like a playground taunt: Ha,
ha! My concepts are more abstruse than yours!).
> -----Original Message-----
> From: Jane Carnall [mailto:jane -dot- carnall -at- digitalbridges -dot- com]
> Sent: 30 July 2001 11:03
> To: TECHWR-L
> Subject: Diplomacy/Templates problem
>
<snip>
>
> Problem... er.. well... Enthusiastically, my manager's
> written 7 examples.
> Count 'em. Seven. One new concept per example.
<snip>
> Am I right about the number of examples? (I think I am, but
> am willing to
> listen to cogently-reasoned disagreement.) If so, what's a
> nicely diplomatic
> way of saying to my boss "Wonderful, but wrong!" (The code
> looks good, from
> my perspective: makes it easy to rewrite, ahem, heavily edit
> the comments.)
>
> Jane Carnall
> Technical Writer, Digital Bridges, Scotland
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.