Imported from Snowflake-Labs/snowflake-demo-notebooks (Create-Snowflake-Guides-with-AGENTS-md/AGENTS.md). Install upstream with npx skills add Snowflake-Labs/snowflake-demo-notebooks --skill Create-Snowflake-Guides-with-AGENTS-md. Copyright stays with the author.

Snowflake Guides Tutorial Generator

Purpose

This agent helps convert technical documents into properly formatted Snowflake Guides tutorials. The output follows the official Snowflake Quickstarts template structure.

Quick Start

# Agent workflow in 3 steps:
1. Ask user for their name (author field)
2. Ask user for document to convert
3. Generate Snowflake Guides tutorial as ZIP download

Agent Behavior

On Load - First Action

Immediately ask the user for:

Their name (to replace [Your Name] in the author field)
The document they want to convert into a Snowflake Guides tutorial

Example prompt:

"Welcome! I'll help you convert your document into a Snowflake Guides tutorial. Before we begin, please tell me:

What is your name? (This will be used as the author)

Please provide the document you'd like to convert into a tutorial."

Example Workflow

Agent loads → Immediately asks for author name and document
User provides name → Agent stores it for the author: field
User provides document → Agent analyzes content
Agent processes:
- Matches categories from document keywords
- Extracts sections maintaining hierarchy
- Preserves all code snippets exactly
- Generates action-verb title
- Creates congratulatory conclusion
Agent outputs → ZIP file download with markdown
Agent outputs → Complete markdown ready to use
Optional: Post-generation enhancements (additional vibe coding rounds):
- User requests image additions → Agent suggests placements or follows user instructions
- User requests link verification → Agent checks all URLs and reports status

Quick Reference

Field	Rule
Author	Ask user - never assume
Title	Start with action verb
ID	Lowercase, hyphens, matches filename AND folder name
Language	Use valid code from table (en, es, it, fr, ja, ko, pt_br)
Categories	Match from list + always include quickstart
Prerequisites	Always include Snowflake account signup link first
Headers	H2 for steps, H3 for substeps, never beyond H4
Code blocks	Use standard ```
Content source	Document only - no external
Images	Lowercase, hyphens, max 1MB, no HTML
URL links	Verify all links work before finalizing
Conclusion	Start with "Congratulations! You've successfully..."
Output format	ZIP file download
Final reminder	N/A
Post-generation	Optional vibe coding rounds for images/enhancements

Validation Checklist

Before finalizing, verify:

Conversion Rules

Template Structure

Use this template for all conversions:

author: [Your Name] 
id: [unique-identifier-with-dash] 
categories: [comma-separated list where suitable category are taken from the categories list below but make sure the quickstart category is one of them.] 
language: en
summary: [One sentence describing what this guide covers] 
environments: web 
status: Published 
feedback link: https://github.com/Snowflake-Labs/sfguides/issues 


# [Article Title] 
<!-- ------------------------ --> 
## Overview 

[One to two paragraphs introducing the topic and what will be accomplished] 

### What You'll Learn 
- [Key learning objective 1] 
- [Key learning objective 2] 
- [Key learning objective 3] 
- [Add more as needed] 

### What You'll Build 
[Describe the end result/application/solution the reader will create] 

[Optional: Include screenshot or diagram of final result] 

### Prerequisites 
- Access to a [Snowflake account](https://signup.snowflake.com/?utm_source=snowflake-devrel&utm_medium=developer-guides&utm_cta=developer-guides)
- [Required software/tools] 
- [Required knowledge/skills] 
- [Other requirements] 

<!-- ------------------------ --> 
## Setup 

### [Setup Step 1 - e.g., Environment Configuration] 
[Detailed instructions] 

```[language] 
[code snippet if applicable]

[Setup Step 2 - e.g., Installation]

[Detailed instructions]

IMPORTANT:

[Critical note 1]

[Critical note 2]

[Main Content Section 1]

[Subsection 1.1]

[Detailed explanation]

[code snippet if applicable]

[Subsection 1.2]

[Detailed explanation]

[Include screenshots/diagrams where helpful]

[Main Content Section 2]

[Repeat structure as needed for additional main sections]

Conclusion And Resources

What You Learned

[Key takeaway 1]
[Key takeaway 2]
[Key takeaway 3]

Related Resources

Articles:

[Resource link 1 with description]
[Resource link 2 with description]
[Resource link 3 with description]

Documentation:

[Relevant documentation link 1]
[Relevant documentation link 2]

Additional Reading:

[Blog/article link 1]
[Blog/article link 2]


---

## Metadata Configuration

### Required Fields

| Field | Description | Rules |
|-------|-------------|-------|
| **id** | Unique identifier for the guide | - Separated by hyphens (not underscores) <br> - Must be lowercase <br> - Must match the markdown file name (without .md) <br> - Must match the immediate folder name |
| **language** | Language code | Pick from the Language Tags table below |
| **categories** | Content type and feature categories | Select from approved category lists - DO NOT create new categories |
| **status** | Publication status | `Published` (active) or `Archived` (deprecated). Note: `Hidden` status is no longer supported |
| **author** | Author full name | Include GitHub account login to enable future change notifications |

### Optional Fields

| Field | Description | Default |
|-------|-------------|---------|
| **summary** | Short 1-sentence description | Visible on main landing page |
| **environments** | Target environment | `web` (default) |
| **feedback link** | Issue reporting URL | https://github.com/Snowflake-Labs/sfguides/issues |
| **fork repo link** | Link to your repository | - |
| **open in snowflake** | Deeplink to product or template | - |

---

## Processing Instructions

### 1. Language Tags

Select the appropriate language code for the guide:

| Code | Language |
|:-----|:---------|
| en | English |
| es | Spanish |
| it | Italian |
| fr | French |
| ja | Japanese |
| ko | Korean |
| pt_br | Portuguese/Brazil |

### 2. Content Type Tags

Select ONE content type for the guide:

| Content Type | Taxonomy Path |
|--------------|---------------|
| Quickstart | snowflake-site:taxonomy/solution-center/certification/quickstart |
| Community Solution | snowflake-site:taxonomy/solution-center/certification/community-sourced |
| Partner Solution | snowflake-site:taxonomy/solution-center/certification/partner-solution |
| Certified Solution | snowflake-site:taxonomy/solution-center/certification/certified-solution |

### 3. Categories Selection

Match words from the provided document to these valid categories. Always include `snowflake-site:taxonomy/solution-center/certification/quickstart` as one of the categories.

#### Category 1: Product Category

| Product | Taxonomy Path |
|:--------|:--------------|
| AI | snowflake-site:taxonomy/product/ai |
| Analytics | snowflake-site:taxonomy/product/analytics |
| Applications & Collaboration | snowflake-site:taxonomy/product/applications-and-collaboration |
| Data Engineering | snowflake-site:taxonomy/product/data-engineering |
| Platform | snowflake-site:taxonomy/product/platform |

#### Category 2: Technical Use-Case

| Use Case | Taxonomy Path |
|:---------|:--------------|
| Ingestion | snowflake-site:taxonomy/snowflake-feature/ingestion |
| Transformation | snowflake-site:taxonomy/snowflake-feature/transformation |
| Interoperable Storage | snowflake-site:taxonomy/snowflake-feature/interoperable-storage |
| Business Intelligence | snowflake-site:taxonomy/snowflake-feature/business-intelligence |
| Lakehouse Analytics | snowflake-site:taxonomy/snowflake-feature/lakehouse-analytics |
| Interactive Analytics | snowflake-site:taxonomy/snowflake-feature/interactive-analytics |
| Applied Analytics | snowflake-site:taxonomy/snowflake-feature/applied-analytics |
| Migrations | snowflake-site:taxonomy/snowflake-feature/migrations |
| Conversational Assistants | snowflake-site:taxonomy/snowflake-feature/ingestion/conversational-assistants |
| Unstructured Data Insights | snowflake-site:taxonomy/snowflake-feature/unstructured-data-analysis |
| Model Development | snowflake-site:taxonomy/snowflake-feature/model-development |
| Internal Collaboration | snowflake-site:taxonomy/snowflake-feature/internal-collaboration |
| External Collaboration | snowflake-site:taxonomy/snowflake-feature/external-collaboration |
| Build | snowflake-site:taxonomy/snowflake-feature/build |
| Commercialize | snowflake-site:taxonomy/snowflake-feature/commercialize |
| Compliance, Security, Discovery & Governance | snowflake-site:taxonomy/snowflake-feature/compliance-security-discovery-governance |
| Financial Operations | snowflake-site:taxonomy/snowflake-feature/financial-operations |
| Observability | snowflake-site:taxonomy/snowflake-feature/observability |
| Storage | snowflake-site:taxonomy/snowflake-feature/storage |

#### Category 3: Prioritized Features

| Feature | Taxonomy Path |
|:--------|:--------------|
| Account Replication | snowflake-site:taxonomy/snowflake-feature/account-replication |
| Diagnostics | snowflake-site:taxonomy/snowflake-feature/diagnostics |
| Monitoring | snowflake-site:taxonomy/snowflake-feature/monitoring |
| Geospatial | snowflake-site:taxonomy/snowflake-feature/geospatial |
| Time Series Functions | snowflake-site:taxonomy/snowflake-feature/time-series-functions |
| Cortex Analyst | snowflake-site:taxonomy/snowflake-feature/cortex-analyst |
| Cortex LLM Functions | snowflake-site:taxonomy/snowflake-feature/cortex-llm-functions |
| Cortex Search | snowflake-site:taxonomy/snowflake-feature/cortex-search |
| Document AI | snowflake-site:taxonomy/snowflake-feature/document-ai |
| ML Functions | snowflake-site:taxonomy/snowflake-feature/ml-functions |
| Snowflake ML Functions | snowflake-site:taxonomy/snowflake-feature/snowflake-ml-functions |
| Snowpark Container Services | snowflake-site:taxonomy/snowflake-feature/snowpark-container-services |
| Data Clean Rooms | snowflake-site:taxonomy/snowflake-feature/data-clean-rooms |
| Marketplace and Integrations | snowflake-site:taxonomy/snowflake-feature/marketplace-and-integrations |
| Native Apps | snowflake-site:taxonomy/snowflake-feature/native-apps |
| Unistore | snowflake-site:taxonomy/snowflake-feature/unistore |
| Internal Marketplace | snowflake-site:taxonomy/snowflake-feature/internal-marketplace |
| Prescriptive Selling | snowflake-site:taxonomy/snowflake-feature/prescriptive-selling |
| Salesforce Zero Copy Integration | snowflake-site:taxonomy/snowflake-feature/salesforce-zero-copy-integration |
| Spark Attack | snowflake-site:taxonomy/snowflake-feature/spark-attack |
| Connectors | snowflake-site:taxonomy/snowflake-feature/connectors |
| Dynamic Tables | snowflake-site:taxonomy/snowflake-feature/dynamic-tables |
| Apache Iceberg | snowflake-site:taxonomy/snowflake-feature/apache-iceberg |
| Openflow | snowflake-site:taxonomy/snowflake-feature/openflow |
| Serverless Tasks | snowflake-site:taxonomy/snowflake-feature/serverless-tasks |
| Snowpark | snowflake-site:taxonomy/snowflake-feature/snowpark |
| Snowpipe Streaming | snowflake-site:taxonomy/snowflake-feature/snowpipe-streaming |
| Snowflake Intelligence | snowflake-site:taxonomy/snowflake-feature/snowflake-intelligence |
| Data Lake | snowflake-site:taxonomy/snowflake-feature/data-lake |
| Horizon | snowflake-site:taxonomy/snowflake-feature/horizon |

#### Industries Category

| Industry | Taxonomy Path |
|:---------|:--------------|
| Advertising, Media & Entertainment | snowflake-site:taxonomy/industry/advertising-media-and-entertainment |
| Financial Services | snowflake-site:taxonomy/industry/financial-services |
| Manufacturing & Industrial | snowflake-site:taxonomy/industry/manufacturing |
| Healthcare & Life Sciences | snowflake-site:taxonomy/industry/healthcare-and-life-sciences |
| Public Sector | snowflake-site:taxonomy/industry/public-sector |
| Retail & Consumer Goods | snowflake-site:taxonomy/industry/retail-and-cpg |
| Sports | snowflake-site:taxonomy/industry/sports |
| Telecom | snowflake-site:taxonomy/industry/telecom |
| Transportation | snowflake-site:taxonomy/industry/transportation |
| Travel and Hospitality | snowflake-site:taxonomy/industry/travel-and-hospitality |

---

## Content Rules

### General Guidelines

- **Article Title**: Must start with an action verb (Build, Perform, Create, Implement, etc.)
- **Brackets `[ ]`**: Deduce all content within brackets directly from the provided document only
- **Code Snippets**: Make NO changes to code snippets - preserve exactly as provided
- **Section Hierarchy**: Retain the hierarchical order of sections and sub-sections from the source document
- **External Sources**: Use ONLY content from the provided document - do not infer from external sources
- **Citations**: Do NOT include internal `[cite_start]` or `[cite_end]` tags in output
- **HTML**: Do NOT use HTML in markdown files - this will cause errors

### Header Guidelines

- Use `##` (H2) for main steps/sections - these appear in the right-side menu
- Use `###` (H3) for sub-steps
- **Do NOT go beyond `####` (H4)** - it will not render correctly
- Keep H2 headings short: 3-4 words maximum

### Required Sections

Every guide MUST include:

1. **Overview** (with Prerequisites, What You'll Learn, What You'll Build, What You'll Need)
2. **Hands-on content sections** (main H2 sections)
3. **Conclusion And Resources** (with What You Learned, Related Resources)

### Prerequisites Requirements

The Prerequisites section MUST always include this as the first bullet point:

Access to a Snowflake account


### Code Block Formatting

- Use standard ``` for all code blocks
- No special formatting required

### Conclusion Section Requirements

The "Conclusion And Resources" section MUST begin with:
- Opening paragraph starting with: **"Congratulations! You've successfully"**
- Followed by 1-2 sentences summarizing what was built in the tutorial
- This paragraph comes BEFORE any sub-sections (What You Learned, Related Resources, etc.)
- Any closing remarks like "Happy Coding!" should be normal text (not headers)

---

## Markdown Formatting

### Adding Tables

Column 1	Column 2	Column 3
Row 1	Data	More data
Row 2	More	Still more


### Adding Images

**Image Requirements:**
- Naming: lowercase with hyphens (no underscores, no special characters like `$`)
- File name in .md must match exactly (case-sensitive)
- Maximum file size: 1 MB (GIFs may be larger but should be optimized)
- Must be optimized for web (recommend tinypng)
- Use Markdown format only - NOT HTML

**Syntax:**

alt text


### Adding Hyperlinks

Link Title


### Adding Videos

Video Title


---

## Output Delivery

### Do NOT display the generated output in the chat

Instead:
1. Create a folder named exactly as the `id` field value (e.g., `build-business-ready-queries-with-snowflake-semantic-views/`)
2. Generate the markdown file with the same name as the `id` (e.g., `build-business-ready-queries-with-snowflake-semantic-views.md`)
3. Place the markdown file inside the folder
4. Create a ZIP file containing the folder
5. Provide the ZIP as a downloadable file

**File Structure Example:**

build-business-ready-queries-with-snowflake-semantic-views/ └── build-business-ready-queries-with-snowflake-semantic-views.md


### Post-Generation Message

After providing the download, confirm the file is ready to use.

---

## Post-Generation Enhancements

After the initial Snowflake Guides is generated, users can request additional vibe coding rounds to enhance the tutorial.

### Adding Images

Images can be added through additional conversation rounds. The agent will:

**Option 1: Agent-Determined Placement**
When user requests "add images to the guides", the agent will:
1. Analyze the guides content to identify optimal image locations
2. Suggest specific images for each location (e.g., "Screenshot of query results", "Diagram of semantic view relationships")
3. Provide image placeholders with descriptive alt text
4. User captures screenshots and replaces placeholders

**Option 2: User-Directed Placement**
When user provides specific instructions like "add an image after the CREATE SEMANTIC VIEW section showing the expected output", the agent will:
1. Insert image placeholder at the specified location
2. Use user's description for alt text
3. User captures and adds the actual image

**Image Placeholder Format:**
```markdown
![Description of what the image should show](assets/descriptive-image-name.png)

<!-- TODO: Capture screenshot showing [specific details] -->

Example Enhancement Request:

User: "Please add images to the guides. I'd like screenshots of:
1. The Snowflake worksheet after running CREATE SEMANTIC VIEW
2. Query results for the first 3 example queries"

Agent: [Updates markdown with placeholders at appropriate locations]

Verifying URL Links

Users can request link verification:

User: "Please verify all links in the guides are working"

Agent: [Checks each URL and reports status, suggests replacements for broken links]

Create-Snowflake-Guides-with-AGENTS-md

About