create-connector-document

Generate Markdown user documentation for data connectors from code and API docs.

60|116|Updated Nov 13, 2025
One-click install
npx skills add https://github.com/databrickslabs/lakeflow-community-connectors --skill create-connector-document
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-connector-document
Source: https://github.com/databrickslabs/lakeflow-community-connectors/tree/main/.claude/skills/create-connector-document
Command: npx skills add https://github.com/databrickslabs/lakeflow-community-connectors --skill create-connector-document

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of public-facing documentation for data connectors, ensuring end-users have clear and comprehensive guides.

Core Features & Use Cases

  • Automated Documentation Generation: Creates README files based on connector code and API documentation.
  • Standardized Template: Ensures all connector documentation follows a consistent format.
  • Use Case: After developing a new connector for a specific data source, use this Skill to automatically generate its user guide, including configuration instructions.

Quick Start

Use the create-connector-document skill to generate documentation for the 'salesforce' connector.

Frequently Asked Questions about create-connector-document

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

FAQPage Schema
How do I generate public-facing documentation for a data connector?▼

Generate connector documentation by synthesizing information from the code implementation and source API documentation to produce a public-facing Markdown README for end-users.

What is the best way to create a user guide for a newly developed data connector?▼

Creating a user guide is best handled by automating Markdown documentation generation from the connector code, ensuring standardized templates that target end-users with connection configuration details.

Can I automatically include connection configuration details in my connector README?▼

Yes, generating connector documentation ensures the inclusion of connection configuration details by synthesizing source API documentation, while actively avoiding internal implementation jargon.

Does the generated connector documentation follow a standardized format?▼

Generated connector documentation follows a consistent, standardized Markdown template, ensuring all data connector guides provide a uniform structure for end-user configuration instructions.

How do I avoid internal implementation jargon when writing data connector documentation?▼

Avoid internal implementation jargon by using automated documentation generation that targets end-users, synthesizing only public-facing details from the code implementation and source API documentation.

When do I need to generate a README for a data connector?▼

Generate a README for a data connector after developing a new connector for a specific data source, using it to automatically create a comprehensive user guide with configuration instructions.