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.
Writing software documentation without the software
Subject:Writing software documentation without the software From:"Brasel, Russell" <russell -dot- brasel -at- hccredit -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 14 Dec 2006 11:24:07 -0600
Has anyone here had an experience like this?
We have a small application that the programmers use to run Stored
Procedures on our accounts. On Monday, one of our programmers showed me
how they use the application-I took notes, got a screenshot, and started
writing my documentation. 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.
I've informed my manager that trying to write software documentation
without the software is like writing a cookbook without testing the
recipes. He hasn't gotten back to me yet, and I need some advice about
making my case. I'm sure I'll be called for a meeting this afternoon.
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-