RE: Agile tech writing

Subject: RE: Agile tech writing
From: "Zuercher, Darrell" <dzuerche -at- tva -dot- gov>
To: "Paul Hanson" <phanson -at- Quintrex -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 9 Apr 2010 11:23:10 -0400

Very true, Paul. That's one reason it is vital to be an active member of
the team. Still, one of the themes in agile development is that the UI
is one of the last things that are developed. If the team adopts that
approach, it leaves little time for the TW and the developer to work
together, since the deadline is looming.

I have found that structuring the documentation based on the Sprint
plan, then fleshing out the details as development is being done (not
necessarily completed), then finalizing it during testing, works well
for parallel development/documentation. Many teams, even agile teams,
likely still relegate the documentation as the last thing to be done. It
is up to the TW to insert herself into the team wherever and whenever
necessary.

--Darrell

-----Original Message-----
From: techwr-l-bounces+dzuerche=tva -dot- gov -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+dzuerche=tva -dot- gov -at- lists -dot- techwr-l -dot- com] On Behalf
Of Paul Hanson
Sent: Friday, April 09, 2010 10:42 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Agile tech writing

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.


Paul Hanson
Technical Writer
Quintrex Data Systems Corp.
505 33rd Avenue SW
Cedar Rapids, IA 52404
(319) 363-5508



-----Original Message-----
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

<snip>
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
thought.

I hope this helps.

--Darrell
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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 dzuerche -at- tva -dot- gov -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit
http://lists.techwr-l.com/mailman/options/techwr-l/dzuerche%40tva.gov


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Agile tech writing: From: Blount, Patricia A
RE: Agile tech writing: From: Zuercher, Darrell
RE: Agile tech writing: From: Paul Hanson

Previous by Author: RE: Agile tech writing
Next by Author: RE: Agile tech writing
Previous by Thread: RE: Agile tech writing
Next by Thread: RE: Agile tech writing


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads