Appearance
In-app help & microcopy audit
Internal checklist for surfacing the refreshed docs directly in the product. Use it to file follow-up issues or implement inline help/tooltips.
Audit checklist
Filters (FilterCard, FlatFilterBuilder, FriendlyFilterBuilder)
- [ ] Add inline hint linking to the Filters & search guide from any screen that shows the filter builder.
- [ ] Surface scope reminder (“Editing products” vs “Editing variants”) near the match toggle.
- [ ] Add contextual tooltip for SKU/barcode filters that repeats the case-sensitivity note.
- [ ] When a job preview returns zero rows, show helper text pointing to the filters guide troubleshooting section.
ActionEditor + VariantFilterAndSelection
- [ ] Mention “One action per job” with a link to
merchant/getting-started/first-edit.md#step-2--choose-what-to-edit. - [ ] Add banner text that references Job history & rollback after a job is queued.
PatternVariableField & PatternUsageTable
- [ ] Provide inline link/button to the Pattern basics section.
- [ ] Tooltip for Use pattern button clarifies how to open the variable picker and mentions sequential base.
- [ ] PatternUsageTable empty state should mention “Preview shows before/after rows once you add a pattern.”
CSV flows
- [ ] Import modal should link to CSV vs in-app comparison.
- [ ] Error banners should cite the CSV import errors doc.
- [ ] When a CSV job partially fails, surface a note about Job history & rollback exports.
Billing / Usage
- [ ] Usage page banner should summarize Free vs paid plans and link to Billing & usage limits.
- [ ] When users hit the cap, the CTA explanation should reiterate that jobs in progress finish but new jobs wait until upgrade/reset.
Proposed microcopy
| Area / component | Microcopy | Source doc |
|---|---|---|
| Filter builder header | “Need a refresher? See Filters & search guide → common recipes.” | tasks/filters-reference.md |
| Match toggle tooltip | “All = AND, Any = OR. Use NOT groups for exclusions.” | tasks/filters-reference.md |
| SKU filter tooltip | “SKU/barcode filters are case-sensitive. Copy exact values from Shopify.” | faq/index.md#are-filters-case-sensitive |
| ActionEditor note | “Each job runs one action. Preview before running; rollback is available for supported fields.” | getting-started/first-edit.md, tasks/job-history-rollback.md |
| Preview banner | “Preview shows sample rows. CSV import/export is coming soon.” | tasks/csv-basics.md |
| Pattern mode tooltip | “Use pattern → Insert variable to combine text with data like vendor, options, or sequential numbers.” | patterns-variables-reference.md#pattern-basics |
| Job History empty state | “Ran a job already? Job History stores before-values for a limited time based on your plan so you can roll back supported fields.” | tasks/job-history-rollback.md |
| CSV import warning | “Keep headers exact (tags_add, metafield:namespace.key) and save as UTF-8.” | tasks/csv-basics.md#map-csv-columns-to-in-app-actions |
| Rate-limit notification | “Large jobs run in batches to respect Shopify API limits. Split by vendor/type for faster completes.” | troubleshooting/rate-limited.md |
| Usage cap banner | “Your current plan reached its cap. Upgrade for more edits or wait for the next reset date.” | tasks/billing-usage.md |
Next steps
- Prioritize the highest-impact microcopy (filters + rollback + usage caps) for the next UI sprint.
- Track implementation issues per component so design/dev can reference the exact strings above.
- After shipping, verify the links point to the correct anchors and that tooltip text matches the docs verbatim.