Docs Write

What it does

The docs-write skill allows AI agents to generate documentation from Metabase data. It can create initial drafts of user guides, API references, or internal knowledge base articles based on structured information within Metabase. The agent can also update existing documentation with new findings and insights derived from the data.

When to use it

• Automated User Guide Creation: Generate a first draft of your application's user guide by extracting relevant information about features and workflows directly from Metabase dashboards.
• API Documentation Updates: Keep API reference materials current by automatically updating descriptions, parameters, and examples based on changes reflected in Metabase data models.
• Internal Knowledge Base Population: Populate an internal knowledge base with documentation derived from frequently asked questions or common troubleshooting steps tracked within Metabase.
• Documentation for Data Changes: Automatically update documentation when underlying data structures or business logic change as reflected in Metabase.

Key capabilities

• Generates documentation drafts
• Updates existing documentation
• Extracts information from Metabase dashboards
• Supports user guides, API references, and knowledge base articles

Example prompts

• "Write a draft of the user guide for the 'Orders' feature based on the data in the Orders dashboard."
• "Update the API reference documentation for the /products endpoint with the latest information from the Product Data Model in Metabase."
• "Create a knowledge base article explaining how to troubleshoot slow query performance, using insights from the Query Performance dashboard."

Tips & gotchas

• The quality of generated documentation depends heavily on the clarity and structure of data within Metabase. Ensure your dashboards are well-organized and contain descriptive labels.