dbTalk Databases Forums  

Need for documentation of VFP-application

comp.databases.xbase.fox comp.databases.xbase.fox


Discuss Need for documentation of VFP-application in the comp.databases.xbase.fox forum.



Reply
 
Thread Tools Display Modes
  #1  
Old   
Eric Liong
 
Posts: n/a

Default Need for documentation of VFP-application - 11-04-2004 , 03:17 PM






Hello all.

I have a programmer who made a Purchase Order system in VFP 8 for me,
a moderately complex application.
He tells me there is no need to have any written documentation for it,
because the program implicitly has all documentation inside it. Thus
any seasoned VFP programmer who gets access to the source code can
find out all he/she needs to know (in order to amend the program or to
troubleshoot a bug).
Is this true?

Any and all comments are appreciated. Thanks in advance.

Eric Liong

Reply With Quote
  #2  
Old   
Rick Bean
 
Posts: n/a

Default Re: Need for documentation of VFP-application - 11-04-2004 , 04:15 PM






Eric,
I believe that all program documentation should start from the system specification document - does that exist?

While "any seasoned VFP programmer" may be able to figure it out after awhile, the more external documentation there is and the more in-line comments there are, the quick that maintenance programmer will be able to be productive.

At the very least you should have good documentation on all the classes that were used, and whatever framework was used. (Commercial, shareware or in-house developed.)

There are a number of applications around that will generate documentation from a VFP project, anywhere from the included (free) FoxDoc, to the more ambitious products like HTML Help Builder http://www.west-wind.com/wwHelp/.

Rick

"Eric Liong" <eliong (AT) cura (DOT) net> wrote

Quote:
Hello all.

I have a programmer who made a Purchase Order system in VFP 8 for me,
a moderately complex application.
He tells me there is no need to have any written documentation for it,
because the program implicitly has all documentation inside it. Thus
any seasoned VFP programmer who gets access to the source code can
find out all he/she needs to know (in order to amend the program or to
troubleshoot a bug).
Is this true?

Any and all comments are appreciated. Thanks in advance.

Eric Liong

Reply With Quote
  #3  
Old   
Gene Wirchenko
 
Posts: n/a

Default Re: Need for documentation of VFP-application - 11-04-2004 , 06:05 PM



eliong (AT) cura (DOT) net (Eric Liong) wrote:

Quote:
I have a programmer who made a Purchase Order system in VFP 8 for me,
a moderately complex application.
He tells me there is no need to have any written documentation for it,
because the program implicitly has all documentation inside it. Thus
any seasoned VFP programmer who gets access to the source code can
find out all he/she needs to know (in order to amend the program or to
troubleshoot a bug).
Is this true?
Of course, but it is not a useful statement.

It may take ages, but it can be figured out. Certainly, good
documentation can help.

Quote:
Any and all comments are appreciated. Thanks in advance.
It is easier for the person who programmed it to work with it.
That does not mean it would be easy for anyone else from a dead start.

Sincerely,

Gene Wirchenko

Computerese Irregular Verb Conjugation:
I have preferences.
You have biases.
He/She has prejudices.


Reply With Quote
  #4  
Old   
Eric Liong
 
Posts: n/a

Default Re: Need for documentation of VFP-application - 11-16-2004 , 06:06 AM



Thanks to Rick and Gene for their posting.
We had no functional spec, nor program spec in this case, that's the
heart of the problem.

Thanks.
Eric


eliong (AT) cura (DOT) net (Eric Liong) wrote in message news:<5d16ccca.0411041317.baa0408 (AT) posting (DOT) google.com>...
Quote:
Hello all.

I have a programmer who made a Purchase Order system in VFP 8 for me,
a moderately complex application.
He tells me there is no need to have any written documentation for it,
because the program implicitly has all documentation inside it. Thus
any seasoned VFP programmer who gets access to the source code can
find out all he/she needs to know (in order to amend the program or to
troubleshoot a bug).
Is this true?

Any and all comments are appreciated. Thanks in advance.

Eric Liong

Reply With Quote
Reply




Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

vB code is On
Smilies are On
[IMG] code is On
HTML code is Off



Powered by vBulletin Version 3.5.3
Copyright ©2000 - 2012, Jelsoft Enterprises Ltd.