oceanbase-sql-doc

Standardize OceanBase SQL reference documentation with frontmatter metadata and a reusable template.

9|1|Updated Jan 16, 2026
One-click install
npx skills add https://github.com/amber-moe/oceanbase-doc-skills --skill oceanbase-sql-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: oceanbase-sql-doc
Source: https://github.com/amber-moe/oceanbase-doc-skills/tree/main/skills/oceanbase-sql-doc
Command: npx skills add https://github.com/amber-moe/oceanbase-doc-skills --skill oceanbase-sql-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a consistent, structured approach to writing OceanBase SQL statement documentation, reducing ambiguity and ensuring uniform formatting across all reference documents.

Core Features & Use Cases

  • Standardized structure: Enforces a uniform document skeleton for SQL statements, including purpose, syntax, parameters, examples, and references.
  • Style compliance: Guides formatting rules, naming conventions, and evidence-backed examples to maintain quality.
  • Use Case: When creating new SQL reference docs for OceanBase, use this skill to ensure the docs follow official guidelines from start to finish.

Quick Start

  • Refer to the SKILL.md structure for the exact doc format and start writing by outlining the "Purpose", "Syntax", "Examples" sections.

Frequently Asked Questions about oceanbase-sql-doc

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

FAQPage Schema
How do I write OceanBase SQL statement documentation that follows official style guidelines?

OceanBase SQL documentation requires a frontmatter-based metadata model and a reusable template covering purpose, syntax, parameters, examples, and references. This structure enforces style compliance, formatting rules, and naming conventions across all reference documents.

What is the standard structure for OceanBase SQL reference docs?

The standard structure for OceanBase SQL reference docs uses a reusable template with sections for purpose, syntax, parameters, examples, and references. It applies a frontmatter-based metadata model to maintain consistency and accuracy across teams.

Can I use this SQL documentation template for editing and reviewing existing OceanBase docs?

Yes, this template applies to creating, editing, and reviewing existing OceanBase SQL reference docs. It enforces style compliance, formatting rules, naming conventions, and evidence-backed examples to maintain quality across teams and projects.

What's the best way to ensure consistency in OceanBase SQL statement documentation across teams?

The best way to ensure consistency is to apply a frontmatter-based metadata model alongside a reusable document template. This enforces uniform formatting, naming conventions, and evidence-backed examples across all OceanBase SQL reference documents.

Do I need frontmatter metadata when creating new SQL reference docs for OceanBase?

Yes, frontmatter metadata is required when creating new OceanBase SQL reference docs. The skill enforces a frontmatter-based metadata model to standardize document attributes, ensuring uniform formatting and accuracy across all reference documents.