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.
If you are working on the doc at the same time as the developer, when you find things that need to change - typos, unclear error messages, renaming check boxes or other UI elements - my experience is that it's easier to do so while they are still doing the coding or have the coding done to a degree that they are doing their own testing. Once it is "done" in their mind and they've moved on, you may have to refocus their attention on what you are doing. If you have a good relationship with the Developer, they'll learn quite quickly that when they have the screens changed, if they give you a copy of the screens or a doc that explains what they are doing, both of you will be happier.
Quintrex Data Systems Corp.
505 33rd Avenue SW
Cedar Rapids, IA 52404
From: techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Zuercher, Darrell
Sent: Friday, April 09, 2010 9:24 AM
To: Blount, Patricia A; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Agile tech writing
Concerning your delivery schedule, one option might be to delay delivery
of the software by one Sprint, in order to complete the documentation.
Feature 1 is developed in Sprint 1. Feature 2 is developed in Sprint 2,
while Feature 1 is documented, and then released. Feature 3 is developed
in Sprint 3, while Feature 2 is documented, and then released. Just a
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-