How to write documentation for microsoft access database? [closed]

Question

Closed. This question is opinion-based. It is not currently accepting answers.

---

Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.

Closed 4 years ago.

Improve this question

I've been developing a small database for my summer internship and I need to write a manual/documentation for it aimed at both users and developers for future use. Thing is...I have no idea where to start or what information to include. Many people I work with have no idea what databases can do so I need to keep it as simple as possible. The database is implemented in Access and I experimented with the database documenter but I think that is overkill. Is there some kind of documentation standard that I can follow or anything of that nature?

Answer 1

As a starter for ten, I'd have thought that the user documentation should be task orientated. (i.e: How to achieve 'X'.)

In terms of the developer documentation, defining the meaning of any non-obvious fields in your schemas, how they're used and the relationships between different tables, etc. would be a good start. (I'm presuming your VBA code is well commented, etc.) You may also want to examine the existing "Documenting Visual Basic with Doxygen" question/answer.

Answer 2

Just straightforward english if you are explaining a process. If you have a series of Macros do a document highlighting to code used in each macro and the order it should be employed. This could aid someone down the line if they are trying to automate the process.