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.
Subject:RE: Bad Documentation and Linux From:"Jon Leer" <jleer -at- leertech -dot- net> To:"'Dan Goldstein'" <DGoldstein -at- riverainmedical -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 7 Dec 2009 08:57:59 -0500
Of course I am generalizing.
Yes, I am referring to customer documentation.
Documentation meant for internal or developer use is typically better
supported. Ideally, I'd prefer to do 100% documentation for that target
audience.
And while you're at how about management giving me a budget? When it comes
to dealing with upper management it downs to cost first, and ROI second.
Jon Leer
Leer Technical Communications
Bedford, NH
603-315-4029
jleer -at- leertech -dot- net http://www.leertech.net
Technical and Business Communication Consulting:
Technical - Manuals to Online Help
Business - Marketing Communication
Content Management - Knowledge Base Development and User Experience
> -----Original Message-----
> From: techwr-l-bounces+jleer=leertech -dot- net -at- lists -dot- techwr-l -dot- com
> [mailto:techwr-l-bounces+jleer=leertech -dot- net -at- lists -dot- techwr-l -dot- com
] On Behalf Of Dan Goldstein
> Sent: Monday, December 07, 2009 8:48 AM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: RE: Bad Documentation and Linux
>
> You're assuming that all documentation is intended for
> customers. Most of the documentation that I produce is
> intended for my fellow employees, including my managers. The
> managers are trained in the documented procedures, and are
> personally responsible for their implementation.
>
> > -----Original Message-----
> > From: Jon Leer
> > Sent: Monday, December 07, 2009 8:40 AM
> > To: 'Robert Lauriston'; TECHWR-L
> > Subject: RE: Bad Documentation and Linux
> >
> > Let's face. The only reason for documentation is because customers
> > demand it. Managers want it to be accurate, but they
> certainly could
> > care less how it gets done, and will never look at it themselves.
> >
>
> This message contains confidential information intended only
> for the use of the addressee(s). If you are not the
> addressee, or the person responsible for delivering it to the
> addressee, you are hereby notified that reading,
> disseminating, distributing, copying, electronic storing or
> the taking of any action in reliance on the contents of this
> message is strictly prohibited. If you have received this
> message by mistake, please notify us, by replying to the
> sender, and delete the original message immediately
> thereafter. Thank you.
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Are you looking for one documentation tool that does it all?
> Author, build, test, and publish your Help files with just
> one easy-to-use tool.
> Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:
>http://www.doctohelp.com/
>
> Help & Manual 5: The all-in-one help authoring tool. True
> single- sourcing -- generate 8 different formats and as many
> different versions as you need from just one project. Fast
> and intuitive. http://www.helpandmanual.com/
>
> ---
> You are currently subscribed to TECHWR-L as jleer -at- leertech -dot- net -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
>http://lists.techwr-l.com/mailman/options/techwr-l/jleer%40lee
rtech.net
>
>
> 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.techwr-l.com/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
>http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at: http://www.doctohelp.com/
Help & Manual 5: The all-in-one help authoring tool. True single- sourcing --
generate 8 different formats and as many different versions as you need
from just one project. Fast and intuitive. http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-