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

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

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

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

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

更新：
Overview of generated documentation

解决方法

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

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

以下是一些建议：

>表结构

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

>与其他表的关系

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

>表的用法

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

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

>“How to document a database”是一个非常类似的问题,因为它特别关注维基文档解决方案.
>“What are the best ways to understand an unfamiliar database”可能会给你一些很好的提示,因为你正在创建有助于处于这种情况的人的文档.
>“How do you document your database structure?”是相关的,但并不紧密,因为它是关于将文档放入元数据本身.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!