Browse Source

Update _includes/writing/language.html

main
Elio Qoshi 6 years ago
parent
commit
9236dddb58
  1. 9
      _includes/writing/language.html

9
_includes/writing/language.html

@ -11,7 +11,7 @@
<p>Don't use apostrophes for plural abbreviations.</p> <p>Don't use apostrophes for plural abbreviations.</p>
<p>Don't use i.e. or e.g.; they are not localization-friendly.</p> <p>Don't use i.e. or e.g.; they are not localization-friendly.</p>
<ul> <ul>
<li><strong>Yes:</strong> Router Console, <a href="http://jira.atlassian.com/">jira.atlassian.com</a>, <a href="http://developer.atlassian.com/">developer.atlassian.com</a></li> <li><strong>Yes:</strong> Router Console, <a href="https://geti2p.org/">geti2p.org</a>,</li>
<li><strong>No:</strong> RC, DVD's, 1990's, i.e., e.g.</li> <li><strong>No:</strong> RC, DVD's, 1990's, i.e., e.g.</li>
</ul> </ul>
<h4>Active voice</h4> <h4>Active voice</h4>
@ -23,7 +23,7 @@
<h4>Bold</h4> <h4>Bold</h4>
<p>Use bold text to draw the reader's eye to key phrases and statements in your email and web content. For product copy or help articles, use bold for static UI elements like menu items, buttons, screen headings, and anything else you want to call attention to. </p> <p>Use bold text to draw the reader's eye to key phrases and statements in your email and web content. For product copy or help articles, use bold for static UI elements like menu items, buttons, screen headings, and anything else you want to call attention to. </p>
<p>If you need to bold an element but the UI doesn't support it, for example, in a dialog header or a UI message, you can use italics instead.</p> <p>If you need to bold an element but the UI doesn't support it, for example, in a dialog header or a UI message, you can use italics instead.</p>
<p>Use italics for fields that might change, like a page name. See italics for more guidelines.</p> <p>Use italics for fields that might change, like a page name.</p>
<ul> <ul>
<li><strong>Yes: </strong>Go to <strong>General Configuration</strong> &gt; <strong>User Macros</strong>.</li> <li><strong>Yes: </strong>Go to <strong>General Configuration</strong> &gt; <strong>User Macros</strong>.</li>
<li><strong>No:</strong><strong>Go to the settings page and click Configuration.</strong></li> <li><strong>No:</strong><strong>Go to the settings page and click Configuration.</strong></li>
@ -82,7 +82,6 @@
<p>See bold for more information about how to format UI elements. <p>See bold for more information about how to format UI elements.
</p> </p>
<ul> <ul>
<li><strong>Yes: </strong>A JIRA workflow is the set of <em>statuses</em> and <em>transitions</em> that an issue goes through during its lifecycle.</li>
<li><strong>Yes:</strong> According to the 2008<em> IT Unplugged</em> report, IT is really unplugged!</li> <li><strong>Yes:</strong> According to the 2008<em> IT Unplugged</em> report, IT is really unplugged!</li>
<li><strong>Yes</strong>: For example, if you create a metric called <em>Time to resolution</em>, other projects can create metrics with that name.</li> <li><strong>Yes</strong>: For example, if you create a metric called <em>Time to resolution</em>, other projects can create metrics with that name.</li>
</ul> </ul>
@ -115,7 +114,7 @@
<p>You don't need to create a list for tasks that have 2 or fewer steps.</p> <p>You don't need to create a list for tasks that have 2 or fewer steps.</p>
<p>To add a new user macro:</p> <p>To add a new user macro:</p>
<ol> <ol>
<li>Go to <img alt="settings cog icon" src="https://confluence.atlassian.com/download/attachments/590259974/Cog.png?version=1&amp;modificationDate=1398739558493&amp;api=v2">&gt; <strong> General Configuration </strong> &gt; <strong> User Macros. </strong></li> <li>Go to Settings &gt; <strong> General Configuration </strong> &gt; <strong> User Personas. </strong></li>
<li>Choose <strong>Create a User Persona.</strong></li> <li>Choose <strong>Create a User Persona.</strong></li>
<li>Enter the persona details.</li> <li>Enter the persona details.</li>
</ol> </ol>
@ -162,7 +161,7 @@
<h4>Style</h4> <h4>Style</h4>
<p>Five great guidelines for clear, concise writing, courtesy of George Orwell:</p> <p>Five great guidelines for clear, concise writing, courtesy of George Orwell:</p>
<ol> <ol>
<li>Don't use a metaphor, simile, or other figure of speech that you see <img alt="(alot)" src="https://dujrsrsgsd3nh.cloudfront.net/img/emoticons/10804/alot-1463726674.png">. </li> <li>Don't use a metaphor, simile, or other figure of speech that you see. </li>
<li>Don't use a long word if a shorter one will do.</li> <li>Don't use a long word if a shorter one will do.</li>
<li>If you can omit a word, do it.</li> <li>If you can omit a word, do it.</li>
<li>Use active voice.</li> <li>Use active voice.</li>

Loading…
Cancel
Save