docs: Add newsletter survey to best practices (#1980)

Co-authored-by: Olasunkanmi Balogun <olasunkanmiibalogun@gmail.com>
Co-authored-by: Matti Nannt <mail@matthiasnannt.com>

apps/formbricks-com/app/docs/best-practices/improve-email-content/page.mdx

@@ -0,0 +1,113 @@
+import DemoPreview from "@/components/dummyUI/DemoPreview";
+import Image from "next/image";
+import NewsletterSurveyType from './choose-survey-type.webp';
+import NewsletterSurveyEmbedCode from './embed-survey-code-in-your-email.webp';
+import NewsletterSurveyEmbedPrompt from './embed-survey-prompt.webp';
+import NewsletterSurveyEditor from './improve-newsletter-content-editor-formbricks.webp';
+import NewsletterSurvey from './improve-newsletter-content-survey-location.webp';
+export const metadata = {
+  title: "Measure email content quality with Formbricks",
+  description:
+    "Measuring the content quality of both transactional and marketing email is a key element for improving customer communication.",
+};
+
+#### Best Practices
+
+# Improve Email Content
+Email remains the predominant way to communicate with your customers. Measure the effectiveness to improve your offering.
+
+
+## Purpose
+
+Measuring the content quality of both transactional and marketing email is a key element for improving customer communication.
+
+## Preview
+
+<DemoPreview template="Improve Newsletter Content" />
+
+## Formbricks Approach
+
+- Embed the survey into your email so it’s part of the newsletter.
+- Use link prefilling to store the answer users clicked on in the email.
+- Dynamic user identification to append reader's email for personalized profiles and follow ups.
+
+## Installation
+
+To embed the newsletter survey into your email, follow these steps:
+
+1. Create new 'Improve Newsletter Content' survey at [app.formbricks.com](https://app.formbricks.com/)
+2. Select how you where you want to display the survey.
+3. Copy the embed code anywhere you want in your newsletter. 
+
+### 1. Create new 'Improve Newsletter Content' Survey
+
+If you don't have an account yet, create one at [app.formbricks.com](https://app.formbricks.com/auth/signup)
+
+Then, create a new survey and look for the "Improve Newsletter Content" template:
+
+<Image
+  src={NewsletterSurvey}
+  alt="Create Improve Newsletter Content by template"
+  quality="100"
+  className="rounded-lg max-w-full sm:max-w-3xl"
+/>
+
+### 2. Customize Survey questions
+
+Customize survey questions, emojis or stars however you like:
+
+<Image
+  src={NewsletterSurveyEditor}
+  alt="Edit Improve Newsletter Content template"
+  quality="100"
+  className="rounded-lg max-w-full sm:max-w-3xl"
+/>
+
+### 3. Configure Survey Settings
+
+When you are done customizing your survey questions, navigate to the Settings tab and choose the type of survey you want. You need to choose Link Survey:
+
+<Image
+  src={NewsletterSurveyType}
+  alt="Choose survey type"
+  quality="100"
+  className="rounded-lg max-w-full sm:max-w-3xl"
+/>
+
+### 4. Choose how you want to embed your survey
+
+After publishing your survey, a modal that prompts you to embed your survey will pop up.
+
+<Image
+  src={NewsletterSurveyEmbedPrompt}
+  alt="Embed newsletter survey"
+  quality="100"
+  className="rounded-lg max-w-full sm:max-w-3xl"
+/>
+
+Select the Embed Survey card and you will be directed to another modal, where the first embed option displayed will be to embed the survey in an email.
+
+### 5. Copy code to embed the survey in your newsletter
+
+Click the button with the “View Embed Code” text at the top right corner of the modal and simply paste the HTML code for your survey anywhere you want it in your newsletter. You can see the preview in the below image:
+
+<Image
+  src={NewsletterSurveyEmbedCode}
+  alt="Embed survey code"
+  quality="100"
+  className="rounded-lg max-w-full sm:max-w-3xl"
+/>
+
+And you're done! Send a test email to yourself and try it out 🤓
+
+
+## Learn about data prefilling 
+
+<Note>
+  ## How does data prefilling work?
+  Learn about how link prefilling and user identification maximize your insights in [this detailed guide](/blog/how-smart-writers-use-formbricks-open-source-tool-to-measure-the-quality-of-their-newsletter-content).
+</Note>
+
+### &nbsp;
+
+# That’s it! 🎉

apps/formbricks-com/components/docs/Navigation.tsx

@@ -218,6 +218,7 @@ export const navigation: Array<NavGroup> = [
       { title: "Feature Chaser", href: "/docs/best-practices/feature-chaser" },
       { title: "Feedback Box", href: "/docs/best-practices/feedback-box" },
       { title: "Docs Feedback", href: "/docs/best-practices/docs-feedback" },
+      { title: "Improve Email Content", href: "/docs/best-practices/improve-email-content" },
     ],
   },
   {

apps/formbricks-com/components/dummyUI/templates.ts

@@ -1,6 +1,6 @@
 import { createId } from "@paralleldrive/cuid2";
 
-import { TSurveyQuestionType } from "@formbricks/types/surveys";
+import { TSurveyHiddenFields, TSurveyQuestionType } from "@formbricks/types/surveys";
 import { TTemplate } from "@formbricks/types/templates";
 import {
   AppPieChartIcon,
@@ -38,6 +38,11 @@ const welcomeCardDefault = {
   showResponseCount: false,
 };
 
+const hiddenFieldsDefault: TSurveyHiddenFields = {
+  enabled: true,
+  fieldIds: [],
+};
+
 export const customSurvey: TTemplate = {
   name: "Start from scratch",
   description: "Create a survey without template.",
@@ -1224,6 +1229,58 @@ export const templates: TTemplate[] = [
       },
     },
   },
+  {
+    name: "Improve Newsletter Content",
+    category: "Growth",
+    objectives: ["increase_conversion", "sharpen_marketing_messaging"],
+    description: "Find out how your subscribers like your newsletter content.",
+    preset: {
+      name: "Improve Newsletter Content",
+      welcomeCard: welcomeCardDefault,
+      questions: [
+        {
+          id: createId(),
+          type: TSurveyQuestionType.Rating,
+          logic: [
+            { value: "5", condition: "equals", destination: "l2q1chqssong8n0xwaagyl8g" },
+            { value: "5", condition: "lessThan", destination: "k3s6gm5ivkc5crpycdbpzkpa" },
+          ],
+          range: 5,
+          scale: "smiley",
+          headline: "How would you rate this weeks newsletter?",
+          required: true,
+          subheader: "",
+          lowerLabel: "Meh",
+          upperLabel: "Great",
+        },
+        {
+          id: "k3s6gm5ivkc5crpycdbpzkpa",
+          type: TSurveyQuestionType.OpenText,
+          logic: [
+            { condition: "submitted", destination: "end" },
+            { condition: "skipped", destination: "end" },
+          ],
+          headline: "What would have made this weeks newsletter more helpful?",
+          required: false,
+          placeholder: "Type your answer here...",
+          inputType: "text",
+        },
+        {
+          id: "l2q1chqssong8n0xwaagyl8g",
+          html: '<p class="fb-editor-paragraph" dir="ltr"><span>Who thinks like you? You\'d do us a huge favor if you\'d share this weeks episode with your brain friend!</span></p>',
+          type: TSurveyQuestionType.CTA,
+          headline: "Thanks! ❤️ Spread the love with ONE friend.",
+          required: false,
+          buttonUrl: "https://formbricks.com",
+          buttonLabel: "Happy to help!",
+          buttonExternal: true,
+          dismissButtonLabel: "Find your own friends",
+        },
+      ],
+      thankYouCard: thankYouCardDefault,
+      hiddenFields: hiddenFieldsDefault,
+    },
+  },
 ];
 
 export const findTemplateByName = (name: string): TTemplate | undefined => {

apps/formbricks-com/components/shared/BestPracticeNavigation.tsx

@@ -79,6 +79,15 @@ export default function BestPracticeNavigation() {
       description: "Give users the chance to share feedback in a single click.",
       category: "Boost Retention",
     },
+
+    {
+      name: "Improve Newsletter Cotent",
+      href: "/improve-newsletter-content",
+      status: true,
+      icon: FeedbackIcon,
+      description: "Improve your newsletter content by showing this survey to your readers.",
+      category: "Boost Retention",
+    },
   ];
 
   return (

apps/web/app/(app)/environments/[environmentId]/surveys/templates/templates.ts

@@ -2200,7 +2200,6 @@ export const templates: TTemplate[] = [
   },
   {
     name: "Improve Newsletter Content",
-
     category: "Growth",
     objectives: ["increase_conversion", "sharpen_marketing_messaging"],
     description: "Find out how your subscribers like your newsletter content.",