mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
129e42b95c
Defers the onboarding usage survey to the instance's first successful processing (the worker writes a one-time onboarding.firstProcessedAt marker and the overlay gates on it), so it reaches engaged users instead of first-landing visitors. Replaces the two questions telemetry already answers (modality preference from tool_used, install method from instance_started) with what it can't infer: prior tool, self-host motivation, and discovery source. Adds feedback_prompt_shown and feedback_prompt_dismissed on all five feedback surfaces (usage survey, per-job prompt, admin install card, global nav dialog, search-miss) so skip and completion rates are measurable, not just submissions. New survey strings translated into all 20 non-English locales.
141 lines
4.0 KiB
TypeScript
141 lines
4.0 KiB
TypeScript
// Single source of truth for the feedback_submitted event's enum fields.
|
|
// Consumed by: the API's Zod validation (apps/api/src/routes/feedback.ts),
|
|
// the API's PostHog event shape (apps/api/src/lib/analytics.ts), and the
|
|
// web app's feedback types (apps/web/src/lib/feedback.ts). Add new values
|
|
// here, not in any of those three. They all derive from this file.
|
|
|
|
export const FEEDBACK_SOURCE_VALUES = [
|
|
"global",
|
|
"tool_result",
|
|
"failed_job",
|
|
"admin_installer",
|
|
"search_miss",
|
|
"onboarding",
|
|
] as const;
|
|
export type FeedbackSource = (typeof FEEDBACK_SOURCE_VALUES)[number];
|
|
|
|
export const FEEDBACK_SURVEY_ID_VALUES = [
|
|
"global-feedback-v1",
|
|
"tool-result-v1",
|
|
"failed-job-v1",
|
|
"admin-install-v1",
|
|
"search-miss-v1",
|
|
"onboarding-usage-v1",
|
|
] as const;
|
|
export type FeedbackSurveyId = (typeof FEEDBACK_SURVEY_ID_VALUES)[number];
|
|
|
|
/**
|
|
* Settings key marking the instance's first successful processing. The worker
|
|
* writes it on the first completed job; the web app gates the onboarding survey
|
|
* on it so the survey only reaches instances that have produced a real result,
|
|
* not first-landing visitors. Shared so the worker and web can never drift.
|
|
*/
|
|
export const ONBOARDING_FIRST_PROCESSED_KEY = "onboarding.firstProcessedAt";
|
|
|
|
export const FEEDBACK_SENTIMENT_VALUES = [
|
|
"great",
|
|
"okay",
|
|
"issue",
|
|
"missing",
|
|
"bug",
|
|
"idea",
|
|
"other",
|
|
] as const;
|
|
export type FeedbackSentiment = (typeof FEEDBACK_SENTIMENT_VALUES)[number];
|
|
|
|
export const FEEDBACK_TYPE_VALUES = [
|
|
"bug",
|
|
"feature_request",
|
|
"confusing_ux",
|
|
"performance",
|
|
"other",
|
|
] as const;
|
|
export type FeedbackType = (typeof FEEDBACK_TYPE_VALUES)[number];
|
|
|
|
export const FEEDBACK_INSTALL_METHOD_VALUES = [
|
|
"docker",
|
|
"docker_compose",
|
|
"source",
|
|
"cloud",
|
|
"other",
|
|
] as const;
|
|
export type FeedbackInstallMethod = (typeof FEEDBACK_INSTALL_METHOD_VALUES)[number];
|
|
|
|
export const FEEDBACK_USAGE_TYPE_VALUES = [
|
|
"personal",
|
|
"team_internal",
|
|
"business_workflow",
|
|
"education",
|
|
"evaluating",
|
|
] as const;
|
|
export type FeedbackUsageType = (typeof FEEDBACK_USAGE_TYPE_VALUES)[number];
|
|
|
|
// The onboarding survey asks only what telemetry cannot infer. Modality
|
|
// preference (tool_used by category) and install method (instance_started's
|
|
// deploy_mode) are already captured by behavior, so the survey spends its
|
|
// questions on identity, prior tool, motivation, and acquisition channel.
|
|
|
|
/** "What were you using before SnapOtter?" — competitor / replacement signal. */
|
|
export const FEEDBACK_PRIOR_TOOL_VALUES = [
|
|
"online_tools",
|
|
"desktop_apps",
|
|
"command_line",
|
|
"self_hosted",
|
|
"nothing",
|
|
] as const;
|
|
export type FeedbackPriorTool = (typeof FEEDBACK_PRIOR_TOOL_VALUES)[number];
|
|
|
|
/** "Why self-host it?" — positioning / motivation signal. */
|
|
export const FEEDBACK_SELFHOST_MOTIVATION_VALUES = [
|
|
"privacy_control",
|
|
"upload_limits",
|
|
"cost",
|
|
"offline",
|
|
"trying",
|
|
] as const;
|
|
export type FeedbackSelfHostMotivation = (typeof FEEDBACK_SELFHOST_MOTIVATION_VALUES)[number];
|
|
|
|
/** "How did you hear about us?" — acquisition channel, invisible to analytics. */
|
|
export const FEEDBACK_DISCOVERY_SOURCE_VALUES = [
|
|
"github",
|
|
"reddit_hn",
|
|
"search",
|
|
"word_of_mouth",
|
|
"other",
|
|
] as const;
|
|
export type FeedbackDiscoverySource = (typeof FEEDBACK_DISCOVERY_SOURCE_VALUES)[number];
|
|
|
|
export const FEEDBACK_IMPORTANT_AREA_VALUES = [
|
|
"images",
|
|
"pdf_docs",
|
|
"video_audio",
|
|
"batch_workflows",
|
|
"ai_tools",
|
|
] as const;
|
|
export type FeedbackImportantArea = (typeof FEEDBACK_IMPORTANT_AREA_VALUES)[number];
|
|
|
|
export const FEEDBACK_FRICTION_AREA_VALUES = [
|
|
"smooth",
|
|
"docker",
|
|
"environment_variables",
|
|
"auth",
|
|
"storage",
|
|
"workers",
|
|
"ai_tools",
|
|
"docs",
|
|
"performance",
|
|
"other",
|
|
] as const;
|
|
export type FeedbackFrictionArea = (typeof FEEDBACK_FRICTION_AREA_VALUES)[number];
|
|
|
|
export const FEEDBACK_ERROR_CATEGORY_VALUES = [
|
|
"validation_error",
|
|
"upload_error",
|
|
"processing_error",
|
|
"timeout",
|
|
"unsupported_format",
|
|
"worker_unavailable",
|
|
"unknown",
|
|
] as const;
|
|
export type FeedbackErrorCategory = (typeof FEEDBACK_ERROR_CATEGORY_VALUES)[number];
|