SuperAPI AI 工具集

generating-database-documentation

数据与分析

查看项目

更新于 10-23 18:43

技能介绍

用途

该技能用于让 Claude 针对已有的数据库架构自动生成完整文档。它通过调用 database-documentation-gen 插件来完成这一过程,目的是节省时间并保证文档的一致性。生成的文档涵盖 ERD 图、表关系,以及数据库对象的详细信息。

主要能力

  • 连接指定数据库并分析其架构。
  • 提取表、列、关系、索引、触发器与存储过程等信息。
  • 生成多种形式的文档,包括 ERD 图、数据字典和交互式 HTML 文档。

使用方式

当用户提出生成数据库文档、ERD 图或数据字典的请求时,Claude 会识别该请求并触发 database-documentation-gen 插件。插件随后连接指定数据库、分析架构,并生成相应文档。

示例一:记录现有数据库。用户请求“为 'users' 数据库生成数据库文档”,技能将激活插件、连接 'users' 数据库并分析其架构,生成包括 ERD 图和数据字典在内的完整文档。

示例二:创建 ERD 图。用户请求“为 'orders' 数据库创建 ERD 图”,技能将激活插件、连接 'orders' 数据库并分析其架构,生成展示该数据库中表之间关系的 ERD 图。

适用场景

  • 为新数据库或现有数据库生成文档。
  • 为架构评审创建 ERD 图。
  • 为数据治理目的产出数据字典。
  • 帮助新团队成员了解数据库项目。

限制与注意事项

  • 需确保 Claude 具备访问数据库架构所需的数据库凭据。
  • 需明确指定要为其生成文档的数据库。
  • 可考虑指定所需的文档输出格式(例如 HTML、Markdown)。
  • 该技能可与其他插件集成以增强文档流程,例如与绘图插件结合以定制 ERD 图,或与文档生成插件结合以创建更复杂的文档格式。

暂未提供的信息

关于该技能的具体收费、价格、支持的具体数据库类型清单、安装命令及平台要求,资料中暂未提供。