Re: "A few things tech writers frequently say"
5. Tech writers donât include more examples because they donât have the
information to write examples.
- The technical writer is not the SME. If the tech writer doesn't ask for
specific examples to do something, the SME cannot provide them. Often the
SMEs provide examples as sample code that cannot execute out of context.
The writer will not necessarily know this, but the writer must ask.
A. Writer has been given a 'toy' system for doc purposes. Does not know it's a toy.
B. Machine supporting writer's example system is obsolete and too slow. Execution of real examples crashes or takes all night. "Good" machines are only in dev lab or at customer sites, but tech writer is blamed for not knowing how to use system, and believes the blame.
C. All the good examples to date are proprietary to the product's original customer.
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.
Learn more: http://bit.ly/ZeOZeQ
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-leave -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
Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
Previous by Author:
Re: Not sure I agree with this
Next by Author: Re: "A few things tech writers frequently say"
Previous by Thread: TechWhirl: Technical Communication Recap for November 15, 2013
Next by Thread: Re: "A few things tech writers frequently say"
Search our Technical Writing Archives & Magazine