Appearance
Emily Knowledge Requirements
What Emily needs to know to effectively assist merchants.
Core Principles
1. A Child Should Be Able to Set Up
Emily's guidance should be so clear that anyone, regardless of technical expertise, can:
- Set up a new location from scratch
- Configure online ordering
- Create menus and items
- Set up payments
- Configure delivery zones
- Manage capacity limits
2. Deep Understanding, Not Just Steps
Emily must understand:
- What each field does
- Why it exists (business purpose)
- How it works (technical implementation)
- Where it affects other systems
- When to use different values
- Who it impacts (staff, customers)
3. Cross-System Awareness
Every backoffice setting can affect:
- Online Ordering (customer web app)
- Kiosk (self-service terminals)
- KDS (kitchen displays)
- Receipts
- Reports
- Third-party integrations
Emily must explain these connections.
Knowledge Categories
1. Feature Knowledge
For each feature, Emily must know:
Feature: [Name]
├── Purpose: Why does this feature exist?
├── Location: Where in backoffice?
├── Fields: Every configurable option
│ ├── Field name and label
│ ├── Data type and validation
│ ├── Default value
│ ├── Dependencies
│ ├── Business logic
│ └── Customer impact
├── Relations: Connected features
├── Examples: Real-world configurations
└── Troubleshooting: Common issues2. Field Knowledge
For each field, Emily must know:
Field: [Name]
├── What: Description of the field
├── Type: Data type (text, number, toggle, etc.)
├── Validation: Rules and constraints
├── Default: Default value
├── Depends On: Parent fields/conditions
├── Business Logic: How it's processed
├── Customer Impact:
│ ├── Online Ordering effect
│ ├── Kiosk effect
│ └── KDS effect
├── Examples: Sample values and use cases
└── Troubleshooting: Field-specific issues3. Workflow Knowledge
Emily must guide through complete workflows:
Workflow: [Name]
├── Goal: What we're trying to achieve
├── Prerequisites: What must be done first
├── Steps: Ordered list of actions
│ ├── Step 1: Navigate to X
│ ├── Step 2: Configure Y
│ └── Step 3: Save and verify
├── Verification: How to confirm success
└── Common Mistakes: What to avoid4. Troubleshooting Knowledge
For each issue, Emily must know:
Issue: [Description]
├── Symptoms: What the user sees
├── Causes: Possible reasons
├── Diagnosis: How to identify the cause
├── Solutions: Step-by-step fixes
└── Prevention: How to avoid in futureKnowledge Depth Levels
Level 1: Basic (What)
- Field exists
- Basic description
- Where to find it
Level 2: Intermediate (How)
- How to configure
- Validation rules
- Default values
- Dependencies
Level 3: Advanced (Why)
- Business logic
- Technical implementation
- Edge cases
- Performance implications
Level 4: Expert (Impact)
- Cross-system effects
- Integration impacts
- Optimization strategies
- Advanced troubleshooting
Emily should operate at Level 3-4 for all features.
Required Knowledge by Feature
High Priority (Must Have Deep Knowledge)
Order Capacity Management ✅
- All 11 fields documented
- Business logic explained
- Customer impact detailed
- Troubleshooting complete
Online Ordering Setup 🔄
- ~25 fields to document
- Time calculation logic
- Scheduling options
- Payment flow
Delivery Zones
- Zone configuration
- Postal code matching
- Fee calculation
- Minimum orders per zone
Menu Items
- Item creation
- Pricing
- Availability
- Allergens
- Images
Modifiers
- Group configuration
- Required vs optional
- Min/max selections
- Price adjustments
Locations
- Profile setup
- Address configuration
- Timezone importance
- Multi-location management
Business Hours
- Schedule configuration
- Multiple time ranges
- Holiday handling
- Impact on ordering
Payments
- Stripe setup
- Payment methods
- Refund handling
- Webhook configuration
Loyalty Program
- Points configuration
- Earning rules
- Redemption rules
- Customer balance
Offers & Promotions
- Offer types
- Conditions
- Usage limits
- Promo codes
Medium Priority
- Team Management
- Devices (Kiosk, KDS)
- Inventory
- Categories
- Menus
- Branding
- Receipts
- Tax Rates
Lower Priority
- Translations
- Languages
- Compliance
- Billing
- Activity Log
- Reports
- Integrations (Deliveroo, Uber Eats, etc.)
Knowledge Format for Azure Search
Each knowledge entry should be structured for optimal search:
json
{
"id": "unique-identifier",
"type": "feature|field|workflow|troubleshooting",
"name": "Human-readable name",
"name_nl": "Dutch name",
"name_fr": "French name",
"name_de": "German name",
"content": "Detailed content in English",
"content_nl": "Dutch content",
"content_fr": "French content",
"content_de": "German content",
"category": "settings|channels|menu|marketing|devices",
"route": "/backoffice/path",
"tags": ["searchable", "keywords"],
"priority": 90,
"embedding": [/* vector */]
}Quality Checklist
Before marking a feature as documented:
- [ ] All fields listed with complete properties
- [ ] Business logic explained clearly
- [ ] Customer impact documented for OO and Kiosk
- [ ] Dependencies mapped
- [ ] Examples provided
- [ ] Troubleshooting guides written
- [ ] Cross-feature relations documented
- [ ] Content ready for translation
Maintenance
When to Update Knowledge
- New Feature: Document before release
- Field Change: Update immediately
- Bug Fix: Add to troubleshooting
- Customer Feedback: Improve explanations
- New Integration: Document connections
Update Process
- Update markdown documentation
- Run extraction script
- Generate translations
- Upload to Azure Search
- Test Emily's responses