Technical Docs

[Aidy680]

I've tried posting this in another forum (see link below) and not had much response, so thought I'd try over here as well.

Basically I'm wondering if there is kind of recognised standard out there for documenting MS Access applications?

Any ideas anyone?

thread705-1528088

 

[jrbarnett]

Depends who the documentation is aimed at - whether you are talking about user documentation, programmer documentation etc.

User documentation needs to fit in with the business processes and aims/objectives of the organisations that will be using it. It could use work area specific language and terms, but needs to avoid IT technical terms (unless the user base are technically literate from an IT perspective).

Technical documentation needs to include comments in source code, an entity relationship diagram for the database schema, explanations of how the business processes map to code and data in the system.

Take a look at

http://mdbdoc.sourceforge.net

for a tool to generate basic technical documentation for your access database. (Note: I wrote it).

John

 

[Aidy680]

Thanks John I'll take a look.