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.
Re: Writing software documentation without the software
Subject:Re: Writing software documentation without the software From:<neilson -at- windstream -dot- net> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 14 Dec 2006 13:38:53 -0500
> Russell Brasel wrote:
> << The only problem is that I don't have the application on my box. I'm
> finding it difficult to properly document the procedure without having
> the program in front of me. Also, our programmers are incredibly busy,
> so I don't feel that I can have them show me the process every time I
> have a question.>>
Additional point: Regardless of anyone's feelings or instructions to the contrary, you, the tech writer, are a surrogate for the user. Your contribution to the product is not only the written material, but also the questions, sometimes very embarrassing ones, that you pose to the software developers. You'll ask, "How is the user supposed to do X?" The answer, "They won't *want* to do X," is often an indication of a problem, and needs to go as high up as you can throw it, while being polite and continuing to do your "assigned" job.
This is yet another reason for you to have access to the program, but it not one you can mention beforehand. Eventually you may be accepted as a member of the development team, rather than as a clerical person who wastes time by asking questions.
-Peter (Also got the T-shirt. Yes, a real one! Worn out now.)
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
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
