Creating User-Friendly Documentation Welcome to a deep dive into the art of technical writing! We'll unravel the secrets behind crafting user-friendly documentation for end users of software. This post will delve into key methods for structuring, formatting, and writing documentation and step-by-step instructions, ensuring that users not only engage with the content but can easily … Continue reading Technical Writing Best Practices
Tag: writing style
The Writing Process
Select the image to open it in a new tab. Writing is hard. Some people even find it intimidating. Writing can be challenging because it requires clear expression of thoughts and ideas, attention to detail, and effective communication. Writing is daunting for some because they struggle with articulating their thoughts, fear making mistakes, or lack … Continue reading The Writing Process
What is Technical Writing?
When I started searching for my first technical writing role, I focused on laying a solid foundation. I aimed to build a theoretical framework that would guide me as I developed my skills and explored my interests in the field. I desired answers to all these questions: What is technical writing? Why is it technical? … Continue reading What is Technical Writing?
Elements of Content
Content, or the topics that are written about in a text, is shaped by several rhetorical elements: Purpose: Why am I writing this? Audience: Who will read it? Context: How, when, where, why, and under what conditions will they read it? Style: How will I write this? What are the structure and cosmetics of my … Continue reading Elements of Content
Commas: “For the Innocent, the Eager, and the Doomed”
"If you bend a branch until it's horizontal, the sap will slow to a stopping point: a comma or colon, made of leaves grown into one another and over one another and hardened. Out of this pause comes a flower, which unfolds itself in spirals, as if the leaf form, unable to keep to its … Continue reading Commas: “For the Innocent, the Eager, and the Doomed”
Dillon Bolding 