Oliver/amazon-transcreation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update Help page for Round 2 / 2.5 / 2.6 changes

Browse source 
- "How it works" mentions supplementary files, batching with caching for
  large briefs, reviewer comments in export
- Configure step: TM Files now described as "leave empty for no TMs"
  (auto-include of campaign channel removed in 2.5) and dynamically
  populated from registry
- New "Supplementary files" subsection on the Upload step explaining
  the per-file locale dropdown, supported formats, and what gets inlined
  into the agent's context
- Monitoring section: dashboard auto-refresh note, plus a new "Inputs
  sent to the agent" subsection pointing to the per-job card
- Reviewing section: spell out that reviewer comments appear in the xlsx
  export (Reviewer (Name): comment) and the file is regenerated on each
  download
- Reference Files / TM section: replacing a TM in place, adding a new
  channel via the free-text autocomplete, dynamic registry-driven channel
  list

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
DJP 2026-05-05 15:06:05 -04:00
parent 70cade819c
commit bd10bc3441
1 changed files with 59 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

69
frontend/src/app/help/page.tsx
View file

@ -81,19 +81,20 @@ export default function HelpPage() {
</p>
<h4>How it works</h4>
<ol className="list-decimal list-inside space-y-1">
<li>You create a job with campaign details, target locales, and a programme (Retail/Prime/Brand)</li>
<li>You upload a source xlsx file containing the English copy</li>
<li>You create a job with campaign details, target locales, programme (Retail/Prime/Brand), TM files, and AI model</li>
<li>You upload a source xlsx file with the English copy, plus optional supplementary files (briefs, glossaries, examples) — gated per-locale or sent globally</li>
<li>You launch the job &mdash; each locale is processed in parallel (up to 4 at a time)</li>
<li>The AI pipeline runs a single consolidated agent per locale that handles TM matching, ranking, transcreation, and compliance in one pass</li>
<li>The AI pipeline runs a consolidated agent per locale that handles TM matching, ranking, transcreation, and compliance in one pass. Large briefs (&gt;70 lines) are split into batches with prompt caching so the system prompt + TM data are paid for once and reused.</li>
<li>You review the output with confidence tiers, backtranslations, and rationale</li>
<li>You approve, request revisions, or add comments on each line</li>
<li>You approve, request revisions, or add comments on each line — comments appear in the exported xlsx alongside the AI rationale</li>
<li>You export the final output as a formatted xlsx (Tab 1: output table, Tab 2: linguistic summary)</li>
</ol>
<h4>Processing time and cost</h4>
<p>
A typical 53-line brief takes about <strong>2-4 minutes per locale</strong> and
costs approximately <strong>$0.30-0.50 per locale</strong> (depending on model). Multiple locales run
simultaneously, so a 12-locale job completes in about 4 minutes total.
simultaneously, so a 12-locale job completes in about 4 minutes total. Briefs of
150+ lines automatically batch with prompt caching to keep costs flat.
</p>
</Section>
@ -135,7 +136,7 @@ export default function HelpPage() {
</tr>
<tr>
<td><strong>TM Files</strong></td>
<td>Select one or more TM channels to load. The campaign channel is auto-selected; add others (e.g. MASS as fallback) for cross-channel reference</td>
<td>Tick the TM channels to load. Channels are populated dynamically from the TM Registry, so any newly-uploaded TM appears automatically. Leave the list empty to send <strong>no TMs</strong> (saves tokens; useful when supplying a cut-down TM via supplementary files)</td>
</tr>
<tr>
<td><strong>Locales</strong></td>
@ -187,6 +188,23 @@ export default function HelpPage() {
(for OOH, Display, etc.) and line breaks are preserved in the output.
</p>
<h4>Supplementary files (optional)</h4>
<p>
On the Upload step you can attach any number of supplementary files
(briefs, term lists, examples, prior creative). Each file gets a
<strong> per-file locale dropdown</strong>:
</p>
<ul className="list-disc list-inside space-y-1">
<li><strong>Global</strong> &mdash; sent to every locale (default)</li>
<li><strong>de-DE / fr-FR / etc.</strong> &mdash; only sent to that one locale (saves tokens; avoids cross-contamination)</li>
</ul>
<p>
Supported formats: <code>.txt</code>, <code>.md</code>, <code>.json</code>, <code>.csv</code>, <code>.tsv</code>, <code>.docx</code>.
Their text is inlined into the agent&apos;s context under a
&ldquo;Supplementary Material&rdquo; heading. Other formats (PDF, images)
are noted by filename only.
</p>
<h4>Step 3: Launch</h4>
<p>
Review the summary, optionally add a <strong>context/override prompt</strong> with
@ -235,10 +253,23 @@ export default function HelpPage() {
If you launch 12 locales, the first 4 start immediately and the
remaining 8 queue up.
</p>
<p>
<strong>Auto-refresh:</strong> the dashboard and the per-job page poll
every 5 seconds while any job is active, so the status updates without
you needing to refresh the page.
</p>
<p>
If a locale fails, you can <strong>re-run</strong> it individually without
affecting other locales.
</p>
<h4>Inputs sent to the agent</h4>
<p>
On each job&apos;s detail page there&apos;s an <strong>Inputs sent to the agent</strong> card
showing the AI model used, which TM files were loaded, the supplementary
files attached, and the context override text. Useful for tracking and
re-prompting on script updates.
</p>
</Section>
{/* Reviewing */}
@ -291,7 +322,13 @@ export default function HelpPage() {
<li><strong>Needs Revision</strong> &mdash; flags the option for rework</li>
<li><strong>Comment</strong> &mdash; add notes or specific feedback</li>
</ul>
<p>All feedback is saved to the database and visible to other team members.</p>
<p>
All feedback is saved to the database and visible to other team members.
<strong> Reviewer comments are appended to the rationale cell in the xlsx export</strong>{" "}
(prefixed <code>Reviewer (Name): &lt;comment&gt;</code>) so they ship downstream
with the rest of the work. The xlsx is regenerated on each download, so
late comments are always picked up.
</p>
</Section>
{/* Locales */}
@ -400,9 +437,21 @@ export default function HelpPage() {
</tbody>
</table>
<p>
TM files are organized by channel (13 channels including Mass, Value, Onsite, Outbound,
UEFA, BDA, and more) and locale. You can select multiple TM channels per job &mdash; the system
loads all selected TM files into the agent&apos;s context for cross-channel reference.
TM files are organized by <strong>channel</strong> (Mass, Value, Onsite, Outbound,
UEFA, BDA, PrimeSpeed, etc.) and <strong>locale</strong>. You can select multiple TM
channels per job &mdash; the system loads all selected TM files into the agent&apos;s
context for cross-channel reference. The Channel dropdown is populated dynamically
from the registry, so any newly-uploaded channel appears automatically.
</p>
<p>
<strong>Replacing a TM:</strong> upload a TM via Admin &gt; TM Files with the same
channel + locale as an existing one and the new file overwrites the old one in
place &mdash; the next job for that channel + locale uses the new content.
</p>
<p>
<strong>Adding a brand-new channel:</strong> the Channel field on the upload page
is a free-text input with autocomplete suggestions. Type any new name (e.g.
<code> PrimeCBM</code>) and it&apos;s registered alongside the existing channels.
</p>
<p>
Admins can upload and manage these files in <strong>Admin &gt; TM Files</strong> and{" "}