
Technical Writing Needs Attention
Introduction Usually, programming tutorials and research papers have been a bit difficult to understand. Not because the code is complicated, but because the attention shifts between the text and its explanation. When someone presents a technical article, the author knows which line matters at each moment but readers might not. We use static artefacts, diagrams, images or even screenshots to explain. This includes: Blog Posts Research & Documentation Code Snippets But programming is not static. When a function is executed, the data flows and state keeps changing. So when we explain these ideas, we freeze everything into a screenshot. Real Problem Consider a simple explanation in a blog. We paste a block of code, then the explanation refers to parts of it. Now the reader has to scroll up/down remember previous lines mentally simulate execution To avoid this, authors often repeat code blocks, shrink snippets and/or split explanations. This is hard work for both writers and readers. Code
Continue reading on Dev.to
Opens in a new tab




