I am wondering how many teams are doing this an how your doing this? I am
looking for best practices.

We started using ScrewTurn Wiki. I have documented everything related to the
application.
* Main application page with everything.
* A page for each file, program, and each subprocedure within a module.
* Since they use categories, a category for each library used in the app,
for each module (so I know what subprocedures reside in there), and one for
the application.
* Each program links back to every program, file, and subprocedure it uses.
* Each file documents every logical (with a listing of keys) and each SQL
view has the SQL statement(s) which created it.
* The application lists every program, library and module for the
application. It also has some basic (undecided if it should be the full)
user documentation, version history, and wishlist.

This should give a few ways to go back and look for what you need quickly
and easily. This took me about 3 days to do, but I would guess it would go
quicker if I documented it as I developed it.

What do you do different? What would you add? I know it is hard to describe
everything without looking at it.


As an Amazon Associate we earn from qualifying purchases.

This thread ...

Follow-Ups:

Follow On AppleNews
Return to Archive home page | Return to MIDRANGE.COM home page

This mailing list archive is Copyright 1997-2021 by midrange.com and David Gibbs as a compilation work. Use of the archive is restricted to research of a business or technical nature. Any other uses are prohibited. Full details are available on our policy page. If you have questions about this, please contact [javascript protected email address].

Operating expenses for this site are earned using the Amazon Associate program and Google Adsense.