Skip to content

Commit

Permalink
Fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
@sheilagomes
sheilagomes committed Feb 23, 2024
1 parent 63e5c6b commit 0d43bd7
Show file tree
Hide file tree
Showing 9 changed files with 120 additions and 120 deletions.
8 changes: 4 additions & 4 deletions ...eview_logs/Admin String Standardization - EN/VTEXAdminstringstandardizationinEnglish.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
<div class="wrapper">
<div class="doc-content flow">
<h1 id="introduction">VTEX Admin string standardization for English</h1>
<p class="intro-content">The VTEX Admin strings were fully reviewed as proposed in the <a class="text-link" href="https://www.google.com/url?q=https://docs.google.com/document/d/1Lnk7BKdQkfrol0EwmSOYWvV2C99Bk-iu_00p6sIMYHI/edit%23&amp;sa=D&amp;source=editors&amp;ust=1692972606928615&amp;usg=AOvVaw2q3LnM5z7Jx6e3YRD94StD">2022 third-quarter OKR</a> of the Localization team. During this process, we applied grammar, tone, and voice corrections to offer a consistent experience for our users throughout platform strings. The review implemented patterns specified in our <a class="text-link" href="https://www.google.com/url?q=https://www.notion.so/vtexhandbook/Style-Guides-a05a5cd05987404aab544032292d6bd2&amp;sa=D&amp;source=editors&amp;ust=1692972606929211&amp;usg=AOvVaw34m3pplXXEi1GyrlIbCDsD">Localization style guides</a>, the CAT tool integrated Localization glossary, VTEX <a class="text-link" href="https://www.google.com/url?q=https://uxwriting.vtex.com/docs/&amp;sa=D&amp;source=editors&amp;ust=1692972606929479&amp;usg=AOvVaw0ygUrtQlJvfx9DwQZ5Qu5t">UX Writing Guidelines</a>, as well as naming and standardization discussions with PMs. In this document, we have included the main reference and standardization points that were applied during the review and that should be maintained in Admin strings.</p>
<p class="intro-content">The VTEX Admin strings were fully reviewed as proposed in the <a class="text-link" href="https://docs.google.com/document/d/1Lnk7BKdQkfrol0EwmSOYWvV2C99Bk-iu_00p6sIMYHI/edit#heading=h.lezk5phgz6d0">2022 third-quarter OKR</a> of the Localization team. During this process, we applied grammar, tone, and voice corrections to offer a consistent experience for our users throughout platform strings. The review implemented patterns specified in our <a class="text-link" href="https://www.notion.so/vtexhandbook/Style-Guides-a05a5cd05987404aab544032292d6bd2">Localization style guides</a>, the CAT tool integrated Localization glossary, VTEX <a class="text-link" href="https://uxwriting.vtex.com/docs/">UX Writing Guidelines</a>, as well as naming and standardization discussions with PMs. In this document, we have included the main reference and standardization points that were applied during the review and that should be maintained in Admin strings.</p>
<h3 class="intro-content" id="capitalization">Capitalization</h3>
<p class="table-intro">These patterns were adopted from the <a class="text-link" href="https://www.google.com/url?q=https://uxwriting.vtex.com/docs/principles/voice-chart&amp;sa=D&amp;source=editors&amp;ust=1692972606930072&amp;usg=AOvVaw2KhThVsmuxQm4SF59tFdkG">Voice Chart</a>&nbsp;available in the UX Writing Guidelines.</p>
<p class="table-intro">These patterns were adopted from the <a class="text-link" href="https://uxwriting.vtex.com/docs/principles/voice-chart">Voice Chart</a>&nbsp;available in the UX Writing Guidelines.</p>

<table>
<tr>
Expand Down Expand Up @@ -171,7 +171,7 @@ <h3 class="intro-content" id="capitalization">Capitalization</h3>
</table>
<h3 class="intro-content" id="grammar-forms">Grammar forms</h3>
<ul>
<li class="bullet">When naming menu items, remember that in EN, <a class="text-link" href="https://www.google.com/url?q=https://www.englishclub.com/grammar/nouns-adjective.htm&amp;sa=D&amp;source=editors&amp;ust=1692972606944567&amp;usg=AOvVaw2NfZOPlUe0oXPq2yJkgsIx">nouns acting as adjectives</a>&nbsp;are used in the singular form. This especially applies to pages with “management” in their name: <span class="bold-text">Offer Management</span>, <span class="bold-text">Affiliate Management</span>, <span class="bold-text">Order Management</span>. Other examples are <span class="bold-text">Custom Order Attributes</span>, <span class="bold-text">Order Authorization</span>, and <span class="bold-text">SKU Bindings</span>.</li>
<li class="bullet">When naming menu items, remember that in EN, <a class="text-link" href="https://www.englishclub.com/grammar/nouns-adjective.htm">nouns acting as adjectives</a>&nbsp;are used in the singular form. This especially applies to pages with “management” in their name: <span class="bold-text">Offer Management</span>, <span class="bold-text">Affiliate Management</span>, <span class="bold-text">Order Management</span>. Other examples are <span class="bold-text">Custom Order Attributes</span>, <span class="bold-text">Order Authorization</span>, and <span class="bold-text">SKU Bindings</span>.</li>
</ul>
<h3 class="intro-content" id="lexical-preferences">Lexical preferences</h3>
<ul>
Expand All @@ -186,7 +186,7 @@ <h3 class="intro-content" id="lexical-preferences">Lexical preferences</h3>
<li class="bullet">As a button taking you to another view, <span class="bold-text">view</span> is the preferred verb instead of “see”.</li>
<li class="bullet">“Freight” and “shipping” were standardized to <span class="bold-text">shipping</span>.</li>
<li class="bullet">The phrase “Do you really want to…” was updated to the more generally used <span class="bold-text">Are you sure you want to…</span></li>
<li class="bullet">The term “profile” was updated to “role” for user permissions as per the official change in terminology described in this <span class="text-link"><a href="https://www.google.com/url?q=https://help.vtex.com/en/announcements/el-termino-access-profile-ha-sido-sustituido-por-role-en-la-interfaz-del--jSmEYL6oN5QFLA20a8Aj9?%26utm_source%3Dautocomplete&amp;sa=D&amp;source=editors&amp;ust=1692972606949113&amp;usg=AOvVaw0j7edGkhhIrsXNuvdapieH">announcement</a></span>.</li>
<li class="bullet">The term “profile” was updated to “role” for user permissions as per the official change in terminology described in this <span class="text-link"><a href="https://help.vtex.com/en/announcements/el-termino-access-profile-ha-sido-sustituido-por-role-en-la-interfaz-del--jSmEYL6oN5QFLA20a8Aj9?&utm_source=autocomplete">announcement</a></span>.</li>
<li class="bullet">The sentence placement of “here” was corrected. “Click here to” is a standard phrase, but in longer sentences, “here” is preferred at the end of the sentences: “Drop your file <span class="bold-text">here</span>” not “Drop here your file” or “Enter your message <span class="bold-text">here</span>” not “Enter here your message.”</li>
<li class="bullet">“Search for” in the sense of “search using an attribute” to get a result set was corrected to <span class="bold-text">Search by</span> [ID, name, etc.]. If it is a placeholder, it can be shortened to simply <span class="bold-text">search</span>.</li>
<li class="bullet">“Created at” was corrected to <span class="bold-text">Created on</span>. “On” is the right preposition to indicate a date (month and day or day). “At” is used to indicate time (hour).</li>
Expand Down
10 changes: 5 additions & 5 deletions ...eview_logs/Admin String Standardization - ES/VTEXAdminstringstandardizationinSpanish.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<div class="wrapper">
<div class="doc-content flow">
<h1 id="introduction">VTEX Admin string standardization for Spanish</h1>
<p class="intro-content">The VTEX Admin strings were fully reviewed as proposed in the <a class="text-link" href="https://www.google.com/url?q=https://docs.google.com/document/d/1Lnk7BKdQkfrol0EwmSOYWvV2C99Bk-iu_00p6sIMYHI/edit%23&amp;sa=D&amp;source=editors&amp;ust=1692972662196062&amp;usg=AOvVaw1NfHb1RZZ-UA4kcfcMV8W7">2022 third-quarter OKR</a>&nbsp;of the Localization team. During this process, we applied grammar, tone, and voice corrections to offer a consistent experience for our users throughout platform strings. The review implemented patterns specified in our <a class="text-link" href="https://www.google.com/url?q=https://www.notion.so/vtexhandbook/Style-Guides-a05a5cd05987404aab544032292d6bd2&amp;sa=D&amp;source=editors&amp;ust=1692972662196663&amp;usg=AOvVaw3yZ7k8iU9Ey5zg_w1g610C">Localization style guides</a>, the CAT tool integrated Localization glossary, VTEX <a class="text-link" href="https://www.google.com/url?q=https://uxwriting.vtex.com/docs/&amp;sa=D&amp;source=editors&amp;ust=1692972662196979&amp;usg=AOvVaw0ty8y6fhLtTkZQfFinoiwK">UX Writing Guidelines</a>, as well as naming and standardization discussions with PMs. In this document, we have included the main reference and standardization points that were applied during the review and that should be maintained in Admin strings.</p>
<p class="intro-content">The VTEX Admin strings were fully reviewed as proposed in the <a class="text-link" href="https://docs.google.com/document/d/1Lnk7BKdQkfrol0EwmSOYWvV2C99Bk-iu_00p6sIMYHI/edit#heading=h.lezk5phgz6d0">2022 third-quarter OKR</a>&nbsp;of the Localization team. During this process, we applied grammar, tone, and voice corrections to offer a consistent experience for our users throughout platform strings. The review implemented patterns specified in our <a class="text-link" href="https://www.notion.so/vtexhandbook/Style-Guides-a05a5cd05987404aab544032292d6bd2">Localization style guides</a>, the CAT tool integrated Localization glossary, VTEX <a class="text-link" href="https://uxwriting.vtex.com/docs/">UX Writing Guidelines</a>, as well as naming and standardization discussions with PMs. In this document, we have included the main reference and standardization points that were applied during the review and that should be maintained in Admin strings.</p>
<h3 class="intro-content" id="capitalization">Capitalization</h3>
<p class="table-intro">Only the first letter of buttons should be capitalized.</p>
<h3 class="intro-content" id="basic-ui-buttons-and-terminology">Basic UI buttons and terminology</h3>
Expand Down Expand Up @@ -102,7 +102,7 @@ <h4 id="a">A</h2>
<p class="bold-text">administrador de la tienda</p>
<p class="index-item">Always use when referring to the <span class="italic-text">retailer</span>&nbsp;(<span class="italic-text">lojista</span>) in the VTEX Admin.</p>
<p class="bold-text">anexo</p>
<p class="index-item">Use for SKU attachments used to customize products. <a class="text-link" href="https://www.google.com/url?q=https://help.vtex.com/es/tutorial/que-es-un-anexo--aGICk0RVbqKg6GYmQcWUm?%26utm_source%3Dautocomplete&amp;sa=D&amp;source=editors&amp;ust=1692972662212439&amp;usg=AOvVaw1QMCUDn0oOdTZs57jtIxlh">See documentation</a>.</p>
<p class="index-item">Use for SKU attachments used to customize products. <a class="text-link" href="https://help.vtex.com/es/tutorial/que-es-un-anexo--aGICk0RVbqKg6GYmQcWUm?&utm_source=autocomplete">See documentation</a>.</p>
<p class="bold-text">adjunto</p>
<p class="index-item">Use for files that will be attached.</p>

Expand Down Expand Up @@ -158,7 +158,7 @@ <h4 id="l">L</h2>

<h4 id="m">M</h2>
<p class="bold-text">máster</p>
<p class="index-item">Avoid using. Example: <span class="italic-text">usuario máster</span>&nbsp;was changed to <a class="italic-text text-link index-item" href="https://www.google.com/url?q=https://help.vtex.com/es/tutorial/que-es-el-usuario-titular--3oPr7YuIkEYqUGmEqIMSEy?%26utm_source%3Dautocomplete&amp;sa=D&amp;source=editors&amp;ust=1692972662224678&amp;usg=AOvVaw1u_esYTbD1le4nJF9_Jkbz">usuario titular</a>.</p>
<p class="index-item">Avoid using. Example: <span class="italic-text">usuario máster</span>&nbsp;was changed to <a class="italic-text text-link index-item" href="https://help.vtex.com/es/tutorial/que-es-el-usuario-titular--3oPr7YuIkEYqUGmEqIMSEy?&utm_source=autocomplete">usuario titular</a>.</p>
<p class="bold-text">marketplace</p>
<p class="index-item">Do not substitute with any Spanish alternative.</p>
<p class="bold-text index-item">medio de pago, not <span class="italic-text">método de pago</span></p>
Expand All @@ -170,7 +170,7 @@ <h4 id="o">O</h2>
<h4 id="p">P</h2>
<p class="bold-text index-item">periodo, not <span class="italic-text">período</span></p>
<p class="bold-text">partner, not <span class="italic-text">socio</span></p>
<p class="index-item">Always use <span class="italic-text">partner</span> when referring to <a class="text-link" href="https://www.google.com/url?q=https://vtex.com/mx-es/&amp;sa=D&amp;source=editors&amp;ust=1692972662228245&amp;usg=AOvVaw2A0UCzjifpMIYilvHbXC2L">VTEX partners</a>, other companies with whom VTEX collaborates. However, you may use <span class="italic-text">asociación</span>&nbsp;to translate <span class="italic-text">partnership</span>. When not referring to VTEX, in a legal context, where they are listing kinds of relationships, you may use <span class="italic-text">socio</span>.</p>
<p class="index-item">Always use <span class="italic-text">partner</span> when referring to <a class="text-link" href="https://vtex.com/mx-es/">VTEX partners</a>, other companies with whom VTEX collaborates. However, you may use <span class="italic-text">asociación</span>&nbsp;to translate <span class="italic-text">partnership</span>. When not referring to VTEX, in a legal context, where they are listing kinds of relationships, you may use <span class="italic-text">socio</span>.</p>
<p class="bold-text">x panel (UI)</p>
<p class="index-item">Use <span class="italic-text">dashboard</span>.</p>
<p class="bold-text">política comercial</p>
Expand All @@ -186,7 +186,7 @@ <h4 id="r">R</h2>

<h4 id="s">S</h2>
<p class="bold-text">x socio</span></p>
<p class="index-item">Always use <span class="italic-text">partner</span> when referring to <a class="text-link" href="https://www.google.com/url?q=https://vtex.com/mx-es/&amp;sa=D&amp;source=editors&amp;ust=1692972662232510&amp;usg=AOvVaw3lKQ7yJrrY6zZjJrd818Tq">VTEX partners</a>, other companies with whom VTEX collaborates. However, you may use <span class="italic-text">asociación</span>&nbsp;to translate <span class="italic-text">partnership</span>. When not referring to VTEX, in a legal context, where they are listing kinds of relationships, you may use <span class="italic-text">socio</span>.</p>
<p class="index-item">Always use <span class="italic-text">partner</span> when referring to <a class="text-link" href="https://vtex.com/mx-es/">VTEX partners</a>, other companies with whom VTEX collaborates. However, you may use <span class="italic-text">asociación</span>&nbsp;to translate <span class="italic-text">partnership</span>. When not referring to VTEX, in a legal context, where they are listing kinds of relationships, you may use <span class="italic-text">socio</span>.</p>
<p class="bold-text">seller</p>
<p class="index-item">Always use <span class="italic-text">seller</span>&nbsp;when referring to sellers of a marketplace. This is the most frequent case in the Admin. In the inStore app, use <span class="italic-text">vendedor</span>&nbsp;when they refer to a sales associate.</p>
<p class="bold-text">status</p>
Expand Down
Loading

0 comments on commit 0d43bd7

Please sign in to comment.