logo标签列表

你偏好哪种文档格式来记录数据库？

sql-serverdatabasedocumentationdocumentation-generation
8
我正在编写一个应用程序，除了其他功能之外，它还会生成MSSQL数据库的MediaWiki文档（对象、表、表数据）。
我的问题是你们更喜欢或必须生成哪些文档格式。我有太多想法要跟进，所以你的回答应该规定我的优先事项 ;)
（我知道SO上还有其他与文档相关的问题，但它们大多涉及如何生成文档（我知道如何生成），并且不要求特定的文档类型或平台）
编辑： 感谢评论。实际上，我已经有了表关系，因为我解析外键。然而，完整的交叉引用可能会有点棘手;)
然而，问题的意思是询问文档类型，例如Word、PDF、ODF等。你们的专业要求或偏好是什么？
更新： 生成文档概述
2个回答
7

看起来你已经决定了一个文档格式，它是基于MediaWiki标记的HTML。

此外，你应该生成实体关系图，这是数据库文档的有用补充（尽管ERD并不能完全说明问题）。

你是指文档组织，即每个页面应该包括哪些标题和内容吗？

以下是一些建议：

  1. 表结构

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

  2. 与其他表的关系

    • 依赖于此表的表
    • 此表依赖的表
    • 有关特殊或隐含关系的注释，这些关系没有通过数据库约束进行强制执行

  3. 表的使用

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

在StackOverflow上还有其他非常接近此问题的问题。

感谢您的输入。如果您对结果感兴趣，请查看更新问题中的链接。 - devio
0
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接