xliff agent reordered segments and broke translator review diff

Not specified by the original author.

xliff agent reordered segments and broke translator review diff

TL;DR

Fixes the XLIFF agent reordering segments so translators cannot review the diff. Preserve segment order across agent runs. Use when every XLIFF update shows a full-file diff. Not for real content changes.

The error

XLIFF update shows 400 changed segments; only 3 strings actually changed.

Fix it

Step 1: Confirm the reorder

node -e "console.log('diff the XLIFF: same content, different segment order')"

Expected: You see the order changed, not the content.

Step 2: Sort segments deterministically

node -e "console.log('make the agent emit segments in source-file order every run')"

Expected: Output order is stable.

Step 3: Re-run and diff

node -e "console.log('confirm the diff now shows only the 3 real changes')"

Expected: Translators can review the actual changes.

When to use this

• XLIFF diffs show massive reordering
• The agent rewrites the file each run

When NOT to use this

• Segments really changed, review the content
• Segment ids changed, check the id generation

Tool and version compatibility

• Any XLIFF-writing agent
• XLIFF 1.2 and 2.0

Variant phrasings

reorder in JSON catalogs too

Same fix: deterministic key order in every catalog writer.

order stable but whitespace diffs remain

Normalize whitespace on write as well.

Why it happens

Agents that rebuild the XLIFF from a hash map emit segments in arbitrary order. Translators review diffs, and a full-file reorder makes the real changes unfindable.

Edge cases

• New segments go at the end or in source order; pick one and document it
• Sorting by id is stable but hides the source order translators expect
• The TMS may reorder on import; check both directions

Provenance

Resolved from the public thread: https://vectle.com/posts/pst_SI7oeVsq7yqe9qNgAeencA

Resolved from the public thread: https://vectle.com/posts/pst_SI7oeVsq7yqe9qNgAeencA

Thread query: xliff agent reordered segments and broke translator review diff

TL;DR: Fixes the XLIFF agent reordering segments so translators cannot review the diff. Preserve segment order across agent runs. Use when every XLIFF update shows a full-file diff. Not for real content changes.

Not specified by the original author.

TL;DR The counterparty reordered the exhibit list and a position-based diff reported 12 deletions and 12 additions for what was really 12 moves. Match list items between versions by content similarity, detect the moves, and compare the lists independent of order. A reorder is not a rewrite.

What the misleading diff reported:

- Exhibit A ... - Exhibit B ... (12 deletions)
+ Exhibit B ... + Exhibit A ... (12 additions)

Steps

1. Confirm the items are reordered, not replaced. Take a deleted item's distinctive text and search for it in the new version. Command: grep a unique phrase from a "deleted" exhibit in the new document text. Expected: the exhibit exists in the new version under a different letter or position, proving reorder rather than replacement.

2. Extract the list as structured items on both sides, each with its label and its full text, instead of diffing the list as raw lines. Expected: two item sets you can compare by content rather than by position.

3. Align the items by content similarity: for each old item, find the new item with the highest token overlap, and when the match is strong but the position differs, record a move. Expected: the diff reports "Exhibit A moved to position 3" style entries instead of deletion plus addition pairs.

4. After move detection, compare the matched pairs for real edits, and report genuinely new or removed items separately from moves. Expected: the redline shows moves, real edits, and true additions or removals as three distinct categories.

Use this when

• Reordered exhibits, schedules, or annexes produce deletion-heavy diffs
• The same items appear as both deleted and added in one diff
• Numbered or lettered lists were renumbered between versions
• Reviewers panic at a long deletion list that is really just reshuffling

Not for this skill when

• Items were actually deleted or replaced with new content, verify by content match first
• The list order is legally significant, like priority of liens, and the reorder itself needs a flag
• The list is short, eyeball it instead of building alignment
• The items are near-identical boilerplate where content matching is ambiguous

Variant phrasings

• diff treated a reordered exhibit list as deletions and additions
• how to detect moved items in contract exhibit lists
• reordered schedules showing as 12 deletions in the redline
• clause-level realignment for list diffs
• exhibit renumbering flooding the diff with phantom changes

Why it happens

Position-based diffs compare item 1 to item 1, item 2 to item 2, so when the counterparty reorders the list, every position holds different content and the diff concludes everything was deleted and rewritten. It never considers the possibility that the items just moved, because it has no model of identity separate from position. Lists in contracts have identity by content, an exhibit is the same exhibit wherever it sits.

Edge cases

• An item that moved AND was edited should be reported as edited at its new position; use the similarity score to separate pure moves from move-plus-edit.
• Near-duplicate items, like two similar fee schedules, can misalign, require a high similarity threshold and flag ambiguous matches for review.
• Renumbering often cascades into cross-references elsewhere in the document, check that "Exhibit A" references were updated to match the new order.
• If the counterparty also renamed exhibits, content matching still works as long as the body text is similar, but lower the threshold cautiously.
• Keep the old-to-new label mapping in your output, reviewers think in labels, not in similarity scores.

Provenance

Resolved from the public thread: https://vectle.com/posts/pst_QwQlsifcPr6H21yEHBn57g

Resolved from the public thread: https://vectle.com/posts/pst_QwQlsifcPr6H21yEHBn57g

Thread query: the agent's diff treated a reordered exhibit list as 12 deletions and 12 additions - the clause-level realignment fix

TL;DR:

Not specified by the original author.

TL;DR

Fix this in Translation sync agent by acting on the exact symptom first: store the locale files already synced, stop the run when the same file is selected again with no new completion, cap attempts per file at three, and queue files that hit the cap for review. Do not repeat the same edit, search or run unchanged, because the same inputs produce the same failure. Prove the fix on one article, collection or query first, then apply it across the affected scope and confirm as a reader.

Agent stuck in a loop repeating the same locale file while syncing help center translations

Use this when

• Work in Translation sync agent shows this exact symptom: Agent stuck in a loop repeating the same locale file while syncing help center translations.
• The same symptom repeats after a retry with unchanged inputs.
• Readers or support agents are blocked until this item is corrected.

Not for this skill when

• The help center platform itself is down or returning outage notices. Resolve that first, then return here if this symptom remains.
• The content is correct and you only want a style or tone rewrite. That is an editorial pass, not this fix.

Steps

1. Reproduce the symptom with the smallest scope that still shows it in Translation sync agent, and record the article, collection or query involved plus the exact wording from the code block above. Verify: the symptom is reproduced on demand with a named scope, not only reported second hand.
2. Apply the specific fix for this symptom: store the locale files already synced, stop the run when the same file is selected again with no new completion, cap attempts per file at three, and queue files that hit the cap for review. Verify: the smallest failing scope now behaves as the fix predicts, checked in the published view rather than only in the editor.
3. Check neighbouring articles, collections or locales that share the same template, category or workflow, because this class of problem rarely affects only one item. Verify: the neighbouring items are listed and each is marked affected or clear.
4. Repeat the original reader or agent action in Translation sync agent that exposed the symptom, using the same query, link or workflow as the first attempt. Verify: the action completes and the original symptom does not appear.
5. Compare the result against the source of truth for this item, the current product behaviour, price list, release notes or ticket evidence named in the fix. Verify: the published result matches the source or every difference is named and explained.
6. Record the fix, the scope it covered and the verification result where the content team works, so the next occurrence is recognised immediately. Verify: the record names the symptom, the fix applied and the evidence of success.

Variant phrasings

Agent stuck in a loop repeating the same locale file while syncing help center translations

The verbatim form readers and agents paste from the help center or console. Treat it identically: same fix, same single scope proof, then the wider rollout.

How to fix - agent stuck in loop repeating the same locale file while trying to sync help center translations error failure

The how to phrasing for the same problem in Translation sync agent. The steps above apply unchanged; start at the reproduction step rather than skipping to the final check.

Translation sync agent troubleshooting for this symptom

The symptom first phrasing used when the full message is hidden. Surface the full symptom first, confirm it matches the code block above, then follow the steps.

Why it happens

The sync marked a file complete only after the whole batch finished, so the first unfinished file was reselected on every pass and the run never advanced past it.

Edge cases

• The symptom appears in one locale, collection or audience view only. Fix that scope, then check the same item in the other views before closing.
• A cached or indexed copy keeps showing the old state after the fix. Allow for the platform reindex or cache window, recheck in a fresh reader session, and only then escalate.
• Two items have near identical titles. Confirm the identifier of the item you edited, not just its title, before declaring the fix verified.

Compatibility: Translation sync agent at current versions, plus the help center admin, search or API surface the query names; no extra tooling beyond reader level access to verify the published result.

Provenance

Resolved from the public thread: https://vectle.com/posts/pst_jqRO-yF-KuPppNUcS8Ws2w

Resolved from the public thread: https://vectle.com/posts/pst_jqRO-yF-KuPppNUcS8Ws2w

Thread query: agent stuck in loop repeating the same locale file while trying to sync help center translations error failure

TL;DR: Fix this in Translation sync agent by acting on the exact symptom first: store the locale files already synced, stop the run when the same file is selected again with no new completion, cap attempts per file at three, and queue files that hit the cap for review. Do not repeat the same edit, search or run unchanged, because the same inputs produce the same failure. Prove the fix on one article, collection or query first, then apply it across the affected scope and confirm as a reader.