Skip to content

Pain Points for Email Template Doc Guide #49

@trivedi-khushi

Description

@trivedi-khushi

Developer Pain Points for email-template.mdx

  • separates conceptual understanding & feature use
  • unclear step context disrupt reading flow.
  • Extensive use of bold, backticks, and long HTML-tag references breaks readability.
  • needs concise explanations
  • Screenshots are not annotated
  • UI changes (e.g., "Publish Draft", "Merge Tags") aren't explained visually or progressively.
  • no dedicated “Getting Started with Email Template” section.
  • Doesn’t follow the natural user journey (design ➝ test ➝ publish ➝ send).
  • example snippet/ expected formats are missing in Markup and schema.org
    -Display Conditions doesn't have examples/visuals.
  • no mention for what to check if the template fails?

New Structure for solution:

  • Overview – What is an Email Template in SuprSend?
  • Designing Emails – Using the drag & drop editor, content blocks, responsive views
    • Using the Drag & Drop Editor
    • Adding and formatting content blocks
    • Responsive design tips (Desktop/Mobile toggle)
  • Dynamic Content – Variables, arrays, merge tags, and display conditions
    • How to add variables
    • Sample JSON + Handlebars syntax
    • Adding array elements
    • Auto-suggestions and Merge Tags
    • Mock data - describe & usage
  • Settings & Markups
    • Subject, From Name, Reply-to, CC/BCC
    • Enable Batching
    • Tenant Selection ➝ (redirection link for dedicated docs: Using Tennat Components in Templates )
    • Gmail Markup Setup & Requirements
    • Using variables in settings & markup JSON
  • Email Preview
    • How to preview your template
  • FAQs
    • Common issues (e.g., missing variable, markup not rendering, template not sending)
    • Debugging tips (chck for mismatched data, unregistered sender domain)

Metadata

Metadata

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions