Skip to content

Commit 1d359c3

Browse files
nickprotopnickprotop
committed
Update documentation for Android and iOS formats
1 parent 952303b commit 1d359c3

2 files changed

Lines changed: 142 additions & 1 deletion

File tree

‎cloud/src/www/docs/cloud.html‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -547,6 +547,8 @@
547547
<a href="#projects" class="sidebar-link">Projects</a>
548548
<a href="#resource-editor" class="sidebar-link">Resource Editor</a>
549549
<a href="#translation" class="sidebar-link">Translation</a>
550+
<a href="#translation-memory" class="sidebar-link">Translation Memory</a>
551+
<a href="#glossary" class="sidebar-link">Glossary</a>
550552
<a href="#cli-sync" class="sidebar-link">CLI Sync</a>
551553
<a href="#teams" class="sidebar-link">Teams & Organizations</a>
552554
<a href="#billing" class="sidebar-link">Billing & Plans</a>
@@ -683,6 +685,145 @@ <h3>Translating Keys</h3>
683685
<li>Click <strong>"Translate"</strong></li>
684686
</ol>
685687

688+
<h2 id="translation-memory">Translation Memory</h2>
689+
<p>Translation Memory (TM) automatically stores your translations for reuse, saving costs and ensuring consistency across your projects.</p>
690+
691+
<h3>What is Translation Memory?</h3>
692+
<p>Translation Memory is a database that remembers every translation you make. When you translate similar or identical text in the future, the system can retrieve cached translations instead of making new API calls.</p>
693+
694+
<h3>Key Benefits</h3>
695+
<ul>
696+
<li><strong>Cost Savings</strong> - Avoid redundant API calls for repeated text</li>
697+
<li><strong>Consistency</strong> - Same source text always produces the same translation</li>
698+
<li><strong>Speed</strong> - Instant matches from cache are faster than API calls</li>
699+
<li><strong>Learning</strong> - Your TM grows over time with every translation</li>
700+
</ul>
701+
702+
<h3>How It Works</h3>
703+
<p>When you translate text:</p>
704+
<ol>
705+
<li><strong>TM Check</strong> - The system first searches your Translation Memory</li>
706+
<li><strong>Exact Match</strong> - If an identical translation exists, it's used immediately (no API call)</li>
707+
<li><strong>Fuzzy Match</strong> - Similar translations above the threshold are suggested</li>
708+
<li><strong>API Call</strong> - Only if no match is found, the translation provider is called</li>
709+
<li><strong>Store</strong> - New translations are automatically saved to your TM</li>
710+
</ol>
711+
712+
<h3>Match Types</h3>
713+
<table>
714+
<tr>
715+
<th>Type</th>
716+
<th>Match %</th>
717+
<th>Behavior</th>
718+
</tr>
719+
<tr>
720+
<td><strong>Exact Match</strong></td>
721+
<td>100%</td>
722+
<td>Automatic reuse, no API call needed</td>
723+
</tr>
724+
<tr>
725+
<td><strong>Fuzzy Match</strong></td>
726+
<td>70-99%</td>
727+
<td>Suggested based on similarity threshold</td>
728+
</tr>
729+
<tr>
730+
<td><strong>No Match</strong></td>
731+
<td>&lt;70%</td>
732+
<td>New translation via API</td>
733+
</tr>
734+
</table>
735+
736+
<h3>Personal vs Organization TM</h3>
737+
<p>Translation Memory works at two levels:</p>
738+
<ul>
739+
<li><strong>Personal TM</strong> - Your individual translations, private to your account</li>
740+
<li><strong>Organization TM</strong> - Shared across all team members in your organization (Team/Enterprise plans)</li>
741+
</ul>
742+
743+
<div class="info-box">
744+
<div class="info-box-title">TM Priority</div>
745+
<p>When looking for matches, the system checks both your personal TM and your organization's shared TM. This means your team benefits from collective translation work.</p>
746+
</div>
747+
748+
<h3>Viewing TM Statistics</h3>
749+
<p>Your dashboard shows TM statistics including:</p>
750+
<ul>
751+
<li>Total entries stored</li>
752+
<li>Reuse count (how often TM matches were used)</li>
753+
<li>Breakdown by language pair</li>
754+
</ul>
755+
756+
<h2 id="glossary">Glossary</h2>
757+
<p>The Glossary feature helps maintain consistent terminology across all your translations by defining approved terms and their translations.</p>
758+
759+
<h3>What is a Glossary?</h3>
760+
<p>A glossary is a curated list of domain-specific terms with their approved translations. When translating, AI providers are instructed to use these exact translations for matching terms.</p>
761+
762+
<h3>Key Benefits</h3>
763+
<ul>
764+
<li><strong>Terminology Consistency</strong> - Same term always translates the same way</li>
765+
<li><strong>Brand Compliance</strong> - Ensure product names are never translated</li>
766+
<li><strong>Domain Accuracy</strong> - Use industry-specific terminology correctly</li>
767+
<li><strong>Team Standardization</strong> - Everyone uses the same approved terms</li>
768+
</ul>
769+
770+
<h3>Types of Glossaries</h3>
771+
<table>
772+
<tr>
773+
<th>Type</th>
774+
<th>Scope</th>
775+
<th>Use Case</th>
776+
</tr>
777+
<tr>
778+
<td><strong>Project Glossary</strong></td>
779+
<td>Single project</td>
780+
<td>Product-specific terminology</td>
781+
</tr>
782+
<tr>
783+
<td><strong>Organization Glossary</strong></td>
784+
<td>All org projects</td>
785+
<td>Company-wide brand terms</td>
786+
</tr>
787+
</table>
788+
789+
<h3>Glossary Inheritance</h3>
790+
<p>Projects can inherit terms from their organization's glossary:</p>
791+
<ul>
792+
<li>Organization terms apply to all projects by default</li>
793+
<li>Project-specific terms can override organization terms</li>
794+
<li>Inheritance can be disabled per-project if needed</li>
795+
</ul>
796+
797+
<h3>Managing Glossary Terms</h3>
798+
<p>To add a glossary term:</p>
799+
<ol>
800+
<li>Open your project and go to <strong>"Glossary"</strong></li>
801+
<li>Click <strong>"Add Term"</strong></li>
802+
<li>Enter the source term (e.g., "Dashboard")</li>
803+
<li>Add translations for target languages (e.g., French: "Tableau de bord")</li>
804+
<li>Optionally add a description for context</li>
805+
<li>Choose case sensitivity (exact match vs. any case)</li>
806+
<li>Click <strong>"Save"</strong></li>
807+
</ol>
808+
809+
<div class="info-box">
810+
<div class="info-box-title">Case Sensitivity</div>
811+
<p>By default, terms are matched case-insensitively ("dashboard" matches "Dashboard"). Enable case-sensitive matching for terms where capitalization matters.</p>
812+
</div>
813+
814+
<h3>How Terms are Enforced</h3>
815+
<p>When using AI-powered translation providers (OpenAI, Claude, etc.):</p>
816+
<ol>
817+
<li>Matching glossary terms are detected in your source text</li>
818+
<li>The AI is instructed to use exact translations for those terms</li>
819+
<li>Translations respect your glossary even for complex sentences</li>
820+
</ol>
821+
822+
<div class="info-box">
823+
<div class="info-box-title">Provider Support</div>
824+
<p>Glossary enforcement works best with AI providers (OpenAI, Claude, Azure OpenAI). Traditional providers like Google Translate don't support contextual instructions.</p>
825+
</div>
826+
686827
<h2 id="cli-sync">CLI Sync</h2>
687828
<p>Sync your local resource files with LRM Cloud using the CLI.</p>
688829

‎cloud/src/www/docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -749,7 +749,7 @@ <h2>Getting Started</h2>
749749
<a href="cloud.html" class="doc-card">
750750
<div class="doc-card-icon">☁️</div>
751751
<h3>LRM Cloud</h3>
752-
<p>Learn how to use the cloud platform for team collaboration, project management, and translation workflows.</p>
752+
<p>Cloud platform for team collaboration, Translation Memory, Glossary management, and translation workflows.</p>
753753
<span class="doc-card-link">Get started</span>
754754
</a>
755755

0 commit comments

Comments
 (0)