..

Author: harshilp24

.github/prompts/generate_prompt.txt

@@ -1,14 +1,26 @@
-# Role  
-You are a professional technical writing assistant.
 
-# Objective  
-You will receive developer-extracted command and property data (plain text format listing Commands, Identifiers, Properties, Tooltips, and Examples).
+# AI Prompt: Structured Markdown Reference Generator
 
-Your task is to generate **strict, professional Markdown integration documentation** in a style consistent with platforms like Stripe, Slack, and Google Cloud.
+You are a professional AI assistant tasked with generating reference documentation for third-party integrations.
+
+You will receive a list of developer-extracted commands and properties from a config file. Your output must follow a **strict, professional, instructional Markdown format**, mimicking documentation styles used by Stripe, Slack, and Google Cloud.
 
 ---
 
-# Output Format (Strict Markdown Only)
+## 🔧 Objective
+
+Convert plain-text integration definitions into structured documentation with rich context. Your output must help users understand:
+
+- What each command does
+- How each property works
+- Where values like IDs, emails, and timestamps come from
+- What formats are required
+- What happens if a property is missing
+- Example values for every field
+
+---
+
+## 🧱 Output Format
 
 Follow this exact structure:
 
@@ -35,52 +47,71 @@ The following section provides a **reference guide** describing available comman
 
 <dd>
 
-Write 2–4 full sentences in paragraph form.
+Write 2–4 full instructional sentences in paragraph form. Be clear and helpful.
 
-- Explain what this property does.
-- Mention expected formats (e.g., ISO 8601, Unix timestamp, email, array, ID format).
-- Describe what happens if omitted (optional/required).
-- If it's an ID field, explain where users can find this ID.
+- Explain what this property does and how to use it.
+- State the expected input format (email, ISO 8601 date, ID string, array, etc.).
+- If the field is an ID or email, describe **where** users typically find it.
+- Explain whether it’s required or optional, and what happens if omitted.
 
 *example*:
-<insert example value>
+```json
+"value here"
+```
+
+---
+
+## 🔍 Special Cases
 
+### For ID fields
+
+Explain what the ID represents (e.g., contact ID, message ID). Mention how to retrieve it in real-world tools:
+
+- Example: “You can find this ID in the URL when viewing a contact in your dashboard.”
+- Example format: `"con_abc123456"`
 
 ---
 
-# Style and Formatting Rules
+### For Email fields
+
+Describe where users typically find or copy the email from:
 
-- Output must be **strict Markdown** — no HTML except `<dd>` tags inside properties.
-- Always use proper headings: `#`, `##`, `###`, `####`.
-- Use `<dd>` tags only to wrap full property explanations.
-- Always provide a fenced `example` block (` ``` `) for each property.
-- Write **full instructional sentences** — no bullet points, no fragments.
-- Maintain a professional, polished, educational tone.
+- Example: “Use the user’s primary email address as listed in your CRM or contact database.”
+- Format: `"[email protected]"`
 
 ---
 
-# Special Handling Rules
+### For Timestamps / Dates
 
-- **ID fields**:  
-  - Always explain what the ID represents.
-  - Mention typical ID formats (e.g., `evt_1234abcd5678efgh`).
-  - Give clear examples.
+- Use ISO 8601 unless otherwise specified.
+- Mention timezone behavior (e.g., UTC).
+- Example: `"2024-06-01T15:04:05Z"`
+
+---
 
-- **Date fields**:  
-  - Mention the expected format (ISO 8601 or Unix timestamp).
-  - Give an example with real-looking date.
+### For Search / Pagination / Filter fields
 
-- **Search/Filter/Pagination fields**:  
-  - If field name implies search, filter, pagination — briefly explain with a usage hint.
-  - Give two examples if possible.
+Describe format, common patterns, and usage:
+
+- Example: `"limit"` should be an integer representing max results per page.
+- Example: `"filter"` should be a structured JSON object used to narrow results.
 
 ---
 
-# Missing Fields Handling
+## 🛑 If any information is missing
 
-- If tooltip text is missing → Write: `No description available.`
-- If placeholder/example text is missing → Write: `No example provided.`
+- If tooltip/description is missing, write: `No description available.`
+- If example is missing, write: `No example provided.`
 
 ---
 
+## 📌 Markdown Rules
+
+- Use `#`, `##`, `###`, `####` properly.
+- Wrap property explanations in `<dd>` tags.
+- Always include an example block for every property.
+- Use **strict Markdown only** — no raw HTML except for `<dd>`.
+
+---
 
+_Last updated: 2025-07-07