Notes on DGLegacy database by PT (started 20040603) ------------------------ Documentation should include: -installation instructions, including: -a list of required aliases (e.g. :Common:, :DGLegacy:) with descriptions of the directories to which each must point -an onscreen, obvious button indicating the location of the documentation -a description of the website structure (directory names & relationships) -a listing of all non-auto-generated web-based files (as well as a list of those that ARE auto-gen'd) -a list of all aliases that must be generated -within each script (immediately after the 'method' line), document scripts upon which each script is DEPENDENT -a simple diagram outlining the flow of data from one table/script/query to another (and with respect to the final HTML output) to help in understanding of the system & in troubleshooting (see image in ...email/outgoing/20040604) Ensure that: -no auto-gen'd files are stored in the same directory as non-auto-gen'd files (with few possible exceptions, and--in any case--these should be well- and prominently-documented)