数据模型文档生成

Generate Doris data model Markdown documentation from table metadata and sampled rows.

135|10|Updated Mar 26, 2026
One-click install
npx skills add https://github.com/opsrobot-ai/opsrobot --skill -opsrobot-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: 数据模型文档生成
Source: https://github.com/opsrobot-ai/opsrobot/tree/main/.cursor/skills/doris-datamodel-docgen
Command: npx skills add https://github.com/opsrobot-ai/opsrobot --skill -opsrobot-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It turns Doris table metadata, comments, and sampled rows into consistent Markdown documentation, so teams can stop hand-writing data model notes and field explanations.

Core Features & Use Cases

  • Extracts database, table, source path, and usage context into a standardized three-section document.
  • Builds column tables with field names, types, comments, and examples while preserving database comments when they exist.
  • Supports JSON or VARIANT columns by flattening nested fields into a dedicated extension section.
  • Fits workflows such as documenting one table, many tables, a prefix-matched table set, or a full Doris database.

Quick Start

Ask the skill to generate Doris data model Markdown for the target table and it will gather metadata, sample rows, and optional LLM descriptions into the required format.

Frequently Asked Questions about 数据模型文档生成

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate data model documentation from Doris table metadata?

Doris data model documentation is generated by extracting table metadata, database comments, and at least 100 sampled rows to produce a standardized three-section Markdown document. This replaces the need to hand-write data model notes and field explanations.

How do I document JSON or VARIANT columns in a Doris database schema?

Documenting JSON or VARIANT columns in a Doris database schema involves flattening nested fields into a dedicated extension section. The skill extracts these nested structures from sampled rows to ensure complex data types are fully represented in the Markdown output.

Can I generate Markdown documentation for multiple Doris tables or a full schema at once?

Yes, you can generate Markdown documentation for multiple Doris tables or a full schema at once. The skill supports workflows for documenting single tables, multiple tables, prefix-matched table sets, or entire Doris databases simultaneously.

Do I need sampled rows to generate Doris data model documentation?

Yes, sampled rows are required to generate Doris data model documentation, with at least 100 sampled rows needed when available. These rows provide the actual data examples used to populate field descriptions and validate the schema documentation.

How does the skill handle Doris table fields that lack database comments?

When Doris table fields lack database comments, the skill uses LLM-assisted descriptions to fill in the gaps. It prioritizes preserving existing database comments when they exist but validates and generates missing field explanations deterministically.