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: What do you write? From:John Posada <jposada01 -at- yahoo -dot- com> To:Tech Writer <a -dot- technicalwriter -at- gmail -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com Date:Wed, 28 Jun 2006 13:48:35 -0700 (PDT)
> thing that bothers me about it. I expected to spend
> most of my time writing user manuals and help files, as
There is nothing wrong with writing internal docs and your manager
has it right. He's interested in knowledge transfer. True, maybe for
now nobody will read the doc because someone knows it, but as soon as
that person, with their knowledge, leaves, your document becomes the
primary source of that knowledge.
The other advantage of good internal docs, especially with the
company being small, is as it grows, the documentation can help get
the newbies be productive in a shorter period of time with less
burden to the experienced developers
> our software is sorely lacking in user documentation. I
> firmly believe that documentation would improve
> the quality of our product.
Documentation doesn't improve the quality of a product. Documentation
may help the customer get more out of a product, but bad software is
Senior Technical Writer
"So long and thanks for all the fish."
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l