<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:content="http://purl.org/rss/1.0/modules/content/">
  <channel>
    <title>Techincal-Writing on Extra Long Division</title>
    <link>https://extralongdivision.com/tags/techincal-writing/</link>
    <description>Recent content in Techincal-Writing on Extra Long Division</description>
    <generator>Hugo</generator>
    <language>en-us</language>
    <lastBuildDate>Tue, 14 Jul 2026 13:52:01 -0700</lastBuildDate>
    <atom:link href="https://extralongdivision.com/tags/techincal-writing/index.xml" rel="self" type="application/rss+xml" />
    <item>
      <title>Please Define Your Jargon</title>
      <link>https://extralongdivision.com/articles/please-define-your-jargon/</link>
      <pubDate>Tue, 14 Jul 2026 13:52:01 -0700</pubDate>
      <guid>https://extralongdivision.com/articles/please-define-your-jargon/</guid>
      <description>&lt;h2 id=&#34;split&#34;&gt;Split.&lt;/h2&gt;
&lt;p&gt;If you&amp;rsquo;re a dancer, you probably thought of someone, hips to the ground, with their legs parallel to each other. If you&amp;rsquo;re a runner, you might have thought of your pace at each mile in a marathon. If you&amp;rsquo;re a bowler, you might have thought of the dreaded 7-10 split.&lt;/p&gt;
&lt;p&gt;Same word. Different meanings.&lt;/p&gt;
&lt;p&gt;Language is like that. Its imprecision can leave things ambiguous. Artists can use this to great effect in novels, poems, plays, etc.&lt;/p&gt;</description>
      <content:encoded><![CDATA[<h2 id="split">Split.</h2>
<p>If you&rsquo;re a dancer, you probably thought of someone, hips to the ground, with their legs parallel to each other. If you&rsquo;re a runner, you might have thought of your pace at each mile in a marathon. If you&rsquo;re a bowler, you might have thought of the dreaded 7-10 split.</p>
<p>Same word. Different meanings.</p>
<p>Language is like that. Its imprecision can leave things ambiguous. Artists can use this to great effect in novels, poems, plays, etc.</p>
<h2 id="technical-writing-cannot-be-ambiuous">Technical Writing Cannot be Ambiuous</h2>
<p>This is rarely intentional, but ambiguity manifests when we assume jargon we use everyday is obvious. Engineers are notorious for this. I.e, <a href="https://dev.to/projekta2/i-built-a-chrome-extension-used-daily-for-pr-review-5-decisions-id-make-differently-4o64">this post about making a chrome extension</a> uses the term &ldquo;MV3&rdquo;<sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup> four times but never defines it.</p>
<p><em>The meaning of MV3 is obvious in a post about chrome extensions.</em></p>
<p><em>You</em> may know exactly what MV3 means, but an article titled <em>&ldquo;5 mistakes I made building an AI chrome extension&rdquo;</em> will attract beginners with little domain space knowledge. If everyone assumes the reader knows what MV3 means, how will a novice ever learn the definition?</p>
<p><em>Just Google it</em>.</p>
<p>Let me remind you that search engines personalize your results. Searching &ldquo;MV3&rdquo; on a seasoned developer&rsquo;s machine may return docs on migrating a service worker. Someone else may get the <a href="https://www.msn.com/en-us/sports/baseball/father-mcgivney-baseball-s-mv3-carved-the-path/ar-AA1JWQH4">2004 St. Louis Cardinals.</a></p>
<p><em>Context makes MV3&rsquo;s meaning clear.</em></p>
<p>The author controls the article&rsquo;s context, but they do not control the readers&rsquo; context. When I wrote &ldquo;split&rdquo; as the first word of this post, I had no idea how you would perceive it. I do not know if you are a dancer or a bowler or a runner. I have no idea what experiences you have when you read my writing.</p>
<p>I can, however, reduce any ambiguity by defining all the jargon I use. There&rsquo;s a way to do this without being cumbersome.</p>
<h2 id="footnotes">Footnotes</h2>
<p>Write your post as you normally would, then, for any acronym, add a footnote. Your writing tools likely have built in support.</p>
<p>Seasoned web developers didn&rsquo;t need to read the footnote to know what MV3 meant. Everyone else has already scrolled down, read the definition, and continued reading. Footnotes are friction-less to knowledge area experts and immensely helpful to everyone else.</p>
<p>Do us all a favor <a href="/articles/idgaf-im-still-using-the-emdash/">—</a> please define your jargon.</p>
<div class="footnotes" role="doc-endnotes">
<hr>
<ol>
<li id="fn:1">
<p>Google Manifest Version 3&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p>
</li>
</ol>
</div>
]]></content:encoded>
    </item>
  </channel>
</rss>
