Salesforce Validation Doc Generator

About

# Salesforce Validation Doc Generator

Do you like doing documentation? If you do, awesome! For the rest of us, here's a tool to at least help with making sure that we can still get documentation fast and accurately even when it may be on the bottom of our list of to do items!

1. **Extracts** your active Salesforce Validation Rule page (name, formula, error message, description, author).  
2. **Generates** a clean, formatted HTML doc in your popup, complete with:
   - A 💡 concise “Purpose” written by AI
   - A 📝 real-world example scenario
   - A beautifully styled formula block

3. **Downloads** your rule documentation as:
   - Microsoft Word (.doc) — opens directly in Word
   - Plain Text (.txt) — for any editor

All AI calls are proxied through your own secure server. **No API keys in the client**, and **no data persists** on our servers—once the AI response returns, it’s sent straight to your browser.

---

## Features

- **One-Click Extraction**  
  Automatically detect and pull down all key fields from any “Validation Rule Detail” page in Salesforce Classic or Lightning.

- **AI-Powered Summaries**  
  Leverage Fireworks.ai to explain the *purpose* of your rule in 1–2 sentences and craft a *real-world example* showing exactly when a user hits that error.

- **Download Options**  
  Choose between a `.doc` file (Word-compatible HTML) or a plain `.txt` file—both generated instantly in your browser.

- **Clean, Consistent Styling**  
  – Sticky header with Generate/Download buttons  
  – Subtle blue ribbon accents on AI sections  
  – Monospaced, scrollable code block for formulas  

- **Privacy & Security**  
  – No client-side API keys  
  – All AI requests forwarded server-side with CORS locked to your extension  
  – Zero persistent storage—your validation rules and AI results live only in your browser session  

---

## How to Use

1. Navigate to any Salesforce Validation Rule Detail page (Classic or Lightning).  
2. Click the **Generate Documentation** button in the toolbar popup.  
3. Watch the spinner as your rule is processed.  
4. Read the formatted output and AI-powered sections right in the popup.  
5. Click **Download Documentation** (now visible) to grab a `.doc` or `.txt` file.  

Get back those hours of manual work and keep your team aligned with up-to-date, shareable rule docs!

---