如何为microsoft access数据库编写文档？

Question

我一直在为暑期实习开发一个小型数据库，我需要编写一本针对用户和开发人员的手册/文档，供将来使用。事情是......我不知道从哪里开始或包含哪些信息。我工作的很多人都不知道数据库可以做什么，所以我需要尽可能地保持它。数据库是在Access中实现的，我用数据库记录器进行了实验，但我认为这样做太过分了。是否存在某种我可以遵循的文档标准或任何性质的文档？

Answer 1

作为十人的首发，我认为用户文档应该是面向任务的。 （即：如何实现'X'。）

就开发人员文档而言，定义模式中任何非显而易见字段的含义，如何使用它们以及不同表之间的关系等都是一个好的开始。 （我假设您的VBA代码评论很好，等等。）您可能还想检查现有的“Documenting Visual Basic with Doxygen”问题/答案。

Answer 2

如果您正在解释一个过程，请直截了当地说英语。 如果您有一系列宏，请执行一个文档，突出显示每个宏中使用的代码以及应该使用的顺序。如果他们试图使流程自动化，这可以帮助某人下线。