我正在写一篇 application除其他功能外,它还生成 MSSQL 数据库(对象、表格、表格数据)的 MediaWiki 文档。
我的问题是您喜欢或需要生成哪些文档格式。我有太多的想法要遵循,所以你的回答应该确定我的优先级;)
(我知道 SO 上还有其他与文档相关的问题,但它们主要涉及如何生成文档(我知道如何生成),并且不询问特定的文档类型或平台)
编辑:
感谢您的评论。实际上我已经有了表关系,因为我解析了外键。然而,完整的交叉引用可能有点棘手;)
然而,这个问题是为了询问文档类型,例如 Word、PDF、ODF 等等。您的专业要求或偏好是什么?
更新:
Overview of generated documentation
听起来您已经决定了一种文档格式,即基于 MediaWiki 标记的 HTML。
您还应该生成 Entity-Relationship Diagrams这是对数据库文档的有用补充(尽管 ERD 也不能说明全部情况)。
您的意思是文档组织,即每页中应包含哪些标题和内容?
这里有一些建议:
表结构
- 列名、数据类型、约束
- 每列的含义和用法
- 触发器和应用程序代码中的额外逻辑约束
- 定义的索引
与其他表的关系
- 依赖于此的表
- 这一个所依赖的表
- 关于特殊或隐式关系的注释,这些关系没有通过数据库约束强制执行
表格的使用
- 在存储过程中的使用
- 在应用程序代码中的使用
- 在 View 中的使用
- 谁有读取和/或写入权限;每个用户或角色的 SQL 权限
StackOverflow 上还有其他与此非常接近的问题。