That's a great idea. Mixing the two was looking very complex. Separating them into distinct documents is probably the best approach.
Good stuff, thanks man. > -----Original Message----- > From: Jerry Johnson [mailto:[EMAIL PROTECTED] > Sent: Wednesday, May 31, 2006 2:54 PM > To: CF-Community > Subject: Re: Baseline documentation of a legacy application > > You have 2 choices of approach. > > Document what it DOES. > Document what it SHOULD DO. > > 1. Documenting what it does gives you the current behavior (even if > that behavior is wrong). Any fixes to this model are considered > changes. This is the best approach if you are coming in flat cold, and > if there is no clear description of what it should be doing. > > 2. Documenting what it should do gives you the current desired > behavior. This does NOT document any desired upgrades or changes in > functionality. This basically writes the requirement document that > SHOULD have been in place before the existing code was started. This > is the best approach if you have some knowledge experts at hand who > can talk you through the current build. This should NOT be used if the > experts (or your boss) cannot distinguish between bugfixes and > changes. > > But, I stress with force, any upgrades or changes should be documented > as a separate document, you are first trying to recreate the build > specs for the current version. Do not co-mingle these documents. > > Jerry > > On 5/31/06, John Galt <[EMAIL PROTECTED]> wrote: > > Ok, > > > > So my initial task at the new job is to do a thorough analysis of an > > existing application, and make suggestion for changes and improvements > both > > small and large. > > > > Right now we need to establish some sort of documented baseline, so we > know > > where we came from (Gov't work). Essentially a requirements document, > with > > all the bad stuff added. > > > > Is this clear? > > > > Does anyone have a template like this?? > > > > I'm not sure how I on one hand make sure a requirement is mentioned, and > if > > it has errors or needs optimization or whatever, it all gets recorded in > an > > easy to read format. > > > > > > > > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~| Message: http://www.houseoffusion.com/lists.cfm/link=i:5:207851 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/5 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:5 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.5 Donations & Support: http://www.houseoffusion.com/tiny.cfm/54
