[Novalug] OT: Question for software developers about documentation

Keith Casey mailinglists at caseysoftware.com
Thu Apr 17 11:23:18 EDT 2008


On Thu, Apr 17, 2008 at 11:07 AM, Jim Ide <jimsmaillists at yahoo.com> wrote:
>  Traditionally, software development teams were expected to write requirements documents,
>  specification documents, user manuals, online help screens, and other end-user documentation

I don't touch a project without a spec being in place.  I usually use
Mediawiki - or something similar - to keep it organized, easily
updatable, etc, but the spec is focused around building out readable
User Stories.  If a developer and your customer can both read it and
make sense of it, that's the key...  beyond that, I don't worry about
too much.  If needed though, you can pull test plans (UAT, CAT, etc)
directly out of those stories.

kc

-- 
D. Keith Casey Jr.
CEO, CaseySoftware, LLC
http://CaseySoftware.com


More information about the Novalug mailing list