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.
> I have wild, ludicrous ideas like:
> Prioritize your efforts!
> 1. Accuracy
> 2. Completeness
> 3. Relevance
> 4. Insight
> 5. Sell more products
> 692. Fonts
> 693. Dirt under your nails
> 694. STC competitions
Thank you for ignoring the virtue of
"completeness" by omitting the other 686
Seriously though, the problem is that
"completeness" is relative. Too much
detail can be a hindrance.
If by "completeness" you mean "an appropriate
level of detail based on analysis of audience needs",
then I think you'd be right on the money. If, on
the other hand, you mean "inclusion of all the
technical details regardless of their usefulness
to the end user" then I think you've described one
of the most common failures of documentation
written by programmers who have been asked to
Order RoboHelp X3 in December and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!
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.