记录数据库的首选文档格式是什么[关闭]

Question

我正在编写一个application，除了其他功能之外，它还可以生成 MSSQL 数据库（对象、表格、表格数据）的 MediaWiki 文档。

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

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

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

但是，这个问题的目的是询问文档类型，例如 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”与您的问题非常相似，因为它专门针对 wiki 文档解决方案。
• "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 等。