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: Xtreme Programming / Agile Development and Documentation
Subject:Re: Xtreme Programming / Agile Development and Documentation From:Tony Markos <ajmarkos -at- yahoo -dot- com> To:HSC Italian <twins398 -at- hotmail -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com Date:Sat, 19 Nov 2005 08:38:52 -0800 (PST)
Heidi:
As a Technical Writer, I want as firm of a functional
specification as possible. And, of course, the most
comprehensive and rigorous functional specs are model
based.
The problem with Xtreme programming is that the
espoused functional specification technique is
something called a User Story. A User Story is kind
of like a Use Case, but is even more lossey- goosey
(i.e, lacking in built-in integration provisions and
comprehensivness checks) - and a Use Case is pretty
darn lossey-gossey!
At least a Use Case is somewhat of a modeling
technique. A User Story is typically just a few
sentences of text. (Holly forced, artifical
partitioning Batman!)
Try tying a bunch of text statements together to come
up with a comprehensive, integrated whole (to serve as
the basis for organizing your docs)!! The
understanding that a User-Story-based functional
specification is going to give me is going to be very
disjointed.
Solution?
* Be aware of the issue and be able to explain it to
management.
* Wait till you have a prototype and document off of
that (vs. planning your work off of pre-prototype
deliverables).
Tony Markos
--- HSC Italian <twins398 -at- hotmail -dot- com> wrote:
> Hello,
>
> Has anyone else out there worked, as the writer, in
> a development
> environment that uses the Xtreme Programming / Agile
> method? The developer I
> work with are using this. I know nothing about it
> and find it useless, which
> is likely due to my lack of understanding.
>
> If anyone has been the tech writer for a project
> where the Xtreme
> programming mehtod was used, and have ANY insight on
> a process for
> documentation, or how I could learn how to work in
> this environment better,
> that would be much appreciated.
>
> TIA,
>
> Heidi
>
__________________________________
Start your day with Yahoo! - Make it your home page! http://www.yahoo.com/r/hs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-