|
Since the beginning of programming, one thing has always
remained the same. You should always keep detailed documentation regarding your
database and application design. Detailed documentation will prove beneficial
to you if you need to debug or modify your work, especially if more than a few
weeks have passed since you last looked at it. Equally important is that other
developers can understand your work in a very short amount of time.
One of the best ways to document your work is right within
the development version of your particular project. Many development
applications give you the ability to create comments and descriptions within
your database and application projects; in areas where the typical user will
never have access. For most situations, this will work quite well. In addition
to the documentation you keep within the application, you could also create
instructional documents and version change logs in text documents and
spreadsheets.
Lack of documentation is a major waste of time, especially
in the maintenance cycle of a project so please document all of your work.
|