我一直在为我的暑期实习开发一个小型数据库，我需要为它编写一份针对用户和开发人员的手册/文档以供将来使用。事情是......我不知道从哪里开始或包含哪些信息。与我一起工作的许多人都不知道数据库可以做什么，所以我需要让它尽可能简单。数据库是在 Access 中实现的，我尝试了数据库记录器，但我认为这太过分了。是否有某种我可以遵循的文档标准或任何类似的标准？
问问题
1882 次
2 回答
0
作为十人的初学者，我认为用户文档应该以任务为导向。（即：如何实现'X'。）
就开发人员文档而言，定义架构中任何非显而易见字段的含义、它们的使用方式以及不同表之间的关系等都是一个好的开始。（我假设您的 VBA 代码有很好的注释，等等。）您可能还想检查现有的“使用 Doxygen 记录 Visual Basic ”问题/答案。
于 2013-08-12T14:13:13.003 回答
0
如果您要解释一个过程，只需简单的英语。如果您有一系列宏，请在文档中突出显示每个宏中使用的代码及其应使用的顺序。如果他们试图自动化这个过程，这可以帮助他们。
于 2013-08-12T14:14:54.143 回答