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: An interview question From:phil stokes <philstokes03 -at- googlemail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 29 Mar 2013 21:47:43 +0700
On 29 Mar 2013, at 21:00, Lynne Wright <Lynne -dot- Wright -at- tiburoninc -dot- com> wrote:
I think that the correct answer is that although a company might not see a
direct monetary return on the cost of documentation, well-written,
comprehensive manuals and on-line help can increase customer satisfaction.
Hmm, interesting point. In one of those moments of synchronicity, I just
happened to read an Apple doc this afternoon that ironically stated, among
other things, that:
A principal goal of object-oriented programming is to make the code you
write as reusable as possibleâ.Reusability is influenced by factors such as
these:
<snip>
***How clear the documentation is***
<snip>
I say "ironically" as Apple docs are about as frustrating as any docs I've
ever read. With the exception of comprehensiveness, in any other terms,
their work falls so far below professional standards of good technical
writing it beggars belief.
Best
Phil http://applehelpwriter.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
From our sponsor Doc-to-Help: Want to see a Doc-To-Help web-based Help sample with DISQUS for user commenting?