用于记录数据库的首选文档格式是什么

Question

我正在编写application，除其他功能外，还会生成MSSQL数据库的MediaWiki文档（对象，表格，表格数据）。

我的问题是您喜欢或需要生成哪种文档格式。我有太多的想法要遵循，所以你的答案应该确定我的优先事项;）

（我知道在SO上还有其他与文档相关的问题，但它们主要涉及如何生成文档（我知道如何），并且不要求特定的文档类型或平台）

编辑： 感谢您的评论。实际上我已经有表关系了，因为我解析了外键。但是，完全交叉引用可能有点棘手;）

然而问题是要求提供文档类型，例如Word，PDF，ODF等等。您的专业要求或偏好是什么？

更新： Overview of generated documentation

Answer 1

听起来您已经决定使用基于MediaWiki标记的HTML文档格式。

此外，您应该生成Entity-Relationship Diagrams，它们是数据库文档的有用补充（尽管ERD也没有说明整个故事）。

您的意思是文档组织，即每个页面中应包含哪些标题和内容？

以下是一些建议：

1. 表格结构

   • 列名，数据类型，约束
   • 每列的含义和用法
   • 触发器和应用程序代码中的额外逻辑约束
   • 定义了索引

2. 与其他表的关系

   • 依赖于此的表格
   • 这个表取决于
   • 关于特殊或隐式关系的说明，没有通过数据库约束强制执行

3. 表的用法

   • 存储过程中的用法
   • 应用程序代码中的用法
   • 视图中的用法
   • 谁有读取和/或写入权限;每个用户或角色的SQL权限

StackOverflow还有其他问题与此非常接近。

• “How to document a database”与您的问题非常相似，因为它专门针对维基文档解决方案。
• “What are the best ways to understand an unfamiliar database”可能会给您一些很好的提示，因为您正在创建可以帮助那些情况的人的文档。
• “How do you document your database structure?”是相关的，但并不紧密，因为它是关于将文档放入元数据本身。

Answer 2

您可能想了解商业供应商对此做些什么。比尔说，你当然需要一个ER图。要查看的商业产品可能包括Embarcadero ER/Studio，Red-Gate SQL Doc，Power Designer等。