atw: Re: XP programming and tech writers
- From: "Steve Hudson" <adslyy5g@xxxxxxxxxx>
- To: <austechwriter@xxxxxxxxxxxxx>
- Date: Fri, 10 Dec 2004 12:15:24 +1100
XP works well for us. I'll get pretty full-on here, you don't have to do
EVERYTHING I do :-)
Start with the functional or technical spec for the component module being
constructed by the team. Do mock-ups on paper or even using a forms designer
that the coders can import (eg get Visual Studio or whatever on your desktop
and a 5 minute lesson)
This way, early on the cycle you have the basic interface and can document
its usage. Done quickly and correctly, this actually forms part of the
quality signoff for the production of that module - the code is tested
against the document instead of the other way around.
It is easy to do it quickly because the coders are working in pairs. One can
chat to you and answer your questions whilst the other is furiously coding.
That is, it is fair easier for a pair of people to perform two tasks than
just one person. So SME availability is usually quite high. Additionally, as
you are the designer behind the interface that lives in the code that Jack
built, the SMEs want to see you to understand some of the interface design
requirements.
Additionally, as they test often, you help design the tests in those early
interviews, one coder interrogates you whilst the other lists the test cases
required. Some of that stuff will be in the functional specification in
front of them, but they won't understand its user application.
So essentially, you can be two steps ahead of them at all times. Getting in
on the ground floor with the interface means you have control over the
textual elements hard-coded into the interface. Then get the programmers to
isolate their text strings into a separate resource file so you can easily
edit that as well. Now you are being a huge help.
When they finish their final unit testing, you are waiting to test it
against the documentation that the coders have as well. Many iterations of
this for each functional area and you have a product.
In the meantime, you can start translating the system architect's work into
lay speak for mass consumption. Concepts, overviews, workflows, all that
sort of thing.
Steve Hudson
Word Heretic, Sydney, Australia
Tricky stuff with Word or words for you.
www.wordheretic.com
ABN: 86 453 419 554
"Qualified Good Tech Writer Dude"
Fellowship of the Ring of Technical Writers, Yeah Baby!
Without prejudice
-----Original Message-----
From: Mick Washbrooke
Has anyone on this list ever worked in a software development house that
uses XP as their development model? If so, what special challenges does XP
pose for the tech writer and how were those challenges met (as opposed to
the standard/usual SDLC model)?
Thanks
-----------------------------------------------------
Mick Washbrooke
Technical writer
Citect Corporation
Tel: 9496-7432
----------------------------------------------------------------------------
-------------------------------------------------------
**************************************************
To post a message to austechwriter, send the message to
austechwriter@xxxxxxxxxxxxxx
To subscribe to austechwriter, send a message to
austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject field.
To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx with
"unsubscribe" in the Subject field.
To search the austechwriter archives, go to
www.freelists.org/archives/austechwriter
To contact the list administrator, send a message to
austechwriter-admins@xxxxxxxxxxxxx
**************************************************
**************************************************
To post a message to austechwriter, send the message to
austechwriter@xxxxxxxxxxxxxx
To subscribe to austechwriter, send a message to
austechwriter-request@xxxxxxxxxxxxx with "subscribe" in the Subject field.
To unsubscribe, send a message to austechwriter-request@xxxxxxxxxxxxx with
"unsubscribe" in the Subject field.
To search the austechwriter archives, go to
www.freelists.org/archives/austechwriter
To contact the list administrator, send a message to
austechwriter-admins@xxxxxxxxxxxxx
**************************************************
Other related posts:
