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

Question

我正在编写一个应用程序,除其他功能外,还生成MSSQL数据库的MediaWiki文档(对象,表,表数据).

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

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

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

但问题是要求提供文档类型,例如Word,PDF,ODF等等.您的专业要求或偏好是什么？

更新: 生成的文档概述

Answer 1

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

此外,您应该生成实体关系图,这是对数据库文档的有用补充(尽管ERD也没有说明整个故事).

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

以下是一些建议:

1. 表结构

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

2. 与其他表的关系

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

3. 表的用法

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

StackOverflow还有其他问题非常接近这个问题.

• " 如何记录数据库 "是一个非常类似的问题,因为它特别是关于维基文档解决方案.
• " 理解不熟悉的数据库的最佳方法是什么？ "可能会为您提供一些很好的技巧,因为您正在创建可以帮助处于这种情况的人的文档.
• " 你如何记录你的数据库结构？ "是相关的,但不是那么密切,因为它是关于将文档放入元数据本身.