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.
> <<concept docs are much more difficult to write. They demand intimate
> and extensive knowledge of the content. And this factor, I believe, is the
> overwhelming reason documentation lacks conceptual information.>>
>
> While writer laziness or lack of detailed knowledge MAY be a contributing
> factor, simple economics and time probably plays a much greater role. All
> documentation is written on a budget and with deadlines. To write
comprehensive
> conceptual information about a product will require extensive time and
budget.
> And while both concepts and procedures are important, given a budget and/or
> limited time which of the two can you provide in the best quality and
quickest.
> Also, which is the one that will be most complained about if it is missing by
> the intended audience?
I would agree with this concept in the sense that most writers lack the content
knowledge to effectively and efficient write conceptual information. Hence, the
lack of technical knowledge does extend deadlines and cost more. However,
writers that DO understand the content can produce both procedure and concept
in the same time a content-ignorant writer would produce merely procedure.
However, I think its a cop-out to say "deadlines are looming, we can't do good
work."
A content-skilled writer can often produce material more efficiently because
he/she does not have to waste time with simple technology questions. Moreover,
such a person is better suited to sorting out the wheat from the chaff when it
comes to content. A technically savvy person knows what information is
relevant. A font fondler does not, and as such has to go through an extended
editing process where the engineers review and re-organize their content to
throw out irrelevant information and include relevant data.
As always, if you know the material you are infinitely in a better position to
not only meet your audience's needs, but also deliver a more comprehensive
package. And I would argue that the exclusion of concept information makes a
document LESS valuable.
Andrew Plato
__________________________________________________
Do you Yahoo!?
Yahoo! Shopping - Send Flowers for Valentine's Day http://shopping.yahoo.com
Buy or upgrade to RoboHelp X3 today and receive the WebHelp
Merge Module for FREE ($299 value). RoboHelp X3's all-new
features include conditional text, completely re-engineered
printed documentation output, Context-sensitive Help Toolkit,
single-source layouts, and more!
Order online today at http://www.ehelp.com/techwr-l
---
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.
