Search This Blog

Showing posts with label knowing your audience. Show all posts
Showing posts with label knowing your audience. Show all posts

Monday, October 3, 2022

Benefits of technical writing

This post is aimed at either those who are thinking about becoming a technical writer or are new at it. But if you're also a seasoned vet, feel free to come along for the ride too.

The following shows how technical writing can help you become a stronger writer. This isn't an exhaustive list. These are just ones that came to mind. 

Improves your writing 

The first benefit of technical writing is that it can improve your writing. When you're constantly documenting, you're constantly writing. And when you're constantly writing, you're constantly getting better. 

Writing is like anything else. To get better, you need to practice, practice, practice.  It's also real world experience to improve your writing. You'll most likely get feedback on what you wrote, so it can help you know how to better document something.

Also, as a technical writer, you need to write succinctly.  Be clear. Be concise. Be straight to the point. Just explain how something works. To become a stronger writer, write in short, clear sentences. Preferably 20 words or less per sentence. Also, write in active voice. If you're explaining how perform a task, use active voice, so it's clear who's performing the action.

Your goal as a technical writer is to clearly communicate a point to your readers. This might seem overwhelming. But don't worry. The more you write, the easier it will get to communicate clearly. Writing will be always be hard work, but you'll know what to do as you gain more experience. 

Reduces or eliminates writer's block

The second benefit of technical writing is it can reduce or eliminate writer's block. What helps in is the fact you have something to write about in front of you. If you have access to a software or a tool, you don't have worry about formulating words out of thin air. You just have to explain how something works based on how it functions. You might also have to describe it, but you don't rely on your imagination. Now, if you don't have access to what you're writing about, make sure you get it.

Once you get an understanding how the tool or software, the words will just flow out. There were times, even I created an outline of a document and interviewed the SME, I didn't have much to say. But after I was able to test and play with the product I'm writing about, the writer's block dissipated.

This seems like an unfair advantage since I have something that's front of me to write about. But anything that gets you past writer's block counts. Let's not assume you must solely rely on your own mind to get pass the blocks. That's not only an unrealistic expectation, that's just false. Any honest writer will admit something outside of themselves helped them overcome writer's block. 

Technical writing just so has it built-in as a profession to overcome writer's block. This built-in remedy is seeking an understanding of what you're trying to write. And if you apply across the board, where you have a clear direction of what you're trying write, you should be overcome the blocks when they come.

Before I became a technical writer, I used to be paralyzed by writer's block constantly. Even when I was a journalist, I struggled to write an article. But now, I can write past the block. Many times, I write way more than I should and I have to prune back quite a bit before I publish. 

Now, we'll always encounter writer's block because we're human. But having a good understanding or direction what you want to write should help you move past it. This leads us to the next benefit.

Organizes your thoughts, even for your creative side

Technical writing can help you organize how you write information. 

When you're explaining how a product works, you'll explain it in a logical order. For example, if I had to explain how to use a wind-up toy car, I would say something like this:

1. Remove the car out from the package.
2. Place the car on a smooth surface.
3. While on the surface, hold the car and turn the wind-up key clockwise until it's fully wound.
4. Let go of the car. 

Explaining things in a logical order wouldn't just apply a set of instructions in a document. You'll be able to structure the doc in a logical order. And if there are a set of related docs, you'll be able to structure them in a way it makes sense.

This is not something you will be able to pick up overnight. The more you understand the product or service you're writing about, the easier it will become to organize content and documentation in a logical order. Being able to map out documentation is key to becoming a solid technical writer.

This benefit isn't confined to technical writing. You can use in other forms of writing, such as novel writing. If you can map out a novel, you can increase your chances in finishing it. (Pantsing a novel is good too. That's my favored approach with first drafts. But if you struggle with writer's block, then mapping might be better.) 

The difference between writing and great writing is not the words themselves, but how you arrange them. 

Better see big picture and details

This fourth benefit also doesn't come immediately; it just emerges. As you understand what you're writing about, you'll start forming a holistic approach to documentation. If there are a set of products or services, you'll start forming mental links between them and creating a documentation chain how they fit together. And as you deepen your understanding of these products and services, you can see how they can benefit your customers. And once you see this bigger picture, you'll have a better grasp on how to write the documentation. Then, the quality of the documentation improves.

As for the details, it too just emerges over times. At first, you might start off just catching grammatical or stylistic issues from either Subject Matter Experts (SMEs), fellow technical writers, if there are others, or yourself. But as you go, you might start noticing other details, such as wonkiness in the User Interface (UI), the pictures or code examples don't reflect what's in the text, or the product or service doesn't do what's supposed to. 

Once you get more in tuned with what you're writing about, your eye for details sharpens. You're not going to be perfect, because no human or even machine is. So, toss that unrealistic expectation into the trash. But, you'll pick up on stuff that's off-kilter. By having an eyes for details where you can tell those who create the product or service if you see something, you might make a difference in improving how your organization can serve their customers.

Focuses your writing 

I love this quote from Mark Twain about what makes a successful book:

"A successful book is not made of what is in it, but what is left out of it."

We can also apply this to technical writing, which leads us to the fifth benefit.  Technical writing can help you focus your writing.

Once you know you understand your audience, you can focus what information you want to include in your documentation. For example, if you there's a screen capture tool and it's for a typical user, you will only include step-by-step instructions on how to take a screenshot. You wouldn't any technical details or backend information about this tool. Now, let's say I had to write documentation about this same tool for backend developers, then I wouldn't include the step-by-step instructions on creating a screenshot. Instead, I would probably create an API documentation for this tool.

Great writing isn't just simply the words or how you organize them. It's also what you include and what left out. It's about focus. This is why knowing your audience matters.  


Always learning something new

This last benefit is built into technical writing. As you document a tool or service, you learn something new about it works. Even if there are no new products or services to document, you learn something new through upgrades, revisions, or updates of these existing products or services. When there's something new to learn, this can keep your writing fresh and further deepens what you know. As you deepen your understanding, your writing also deepen. 

I've never felt technical writing gets stale because you can become this ever-expanding knowledge base of information.

The learning never stops, you just choose to stop learning.

Highs and lows but still good

I can say more but I think you get the picture.

Technical writing has had its highs and lows with me, even times when I want to be done with it. But it's the style of writing that I enjoy. I get to write, help others by explaining something to them, and get paid well for doing this. Sounds like a good deal for me. 

I've become a stronger writer from technical writing. I still enjoy it, even after all these years. I continue to get stronger as I go along. Lord willing, I'll continue with technical writing. And I hope you either jump into the technical writing world or will continue with it too.

Tuesday, March 19, 2019

Technical Writing: No Room for Egos

When you are a technical writer or you want to be one, the first rule is this: It's not about you! But if you balk at this, you'll be sorely disappointed. And honestly, technical writing isn't for you.

Not All Writers Are Equal

 
Technical writing is a writing role where you are there to serve others. You are not writing something that emanates from your muse or your inner author. If you want to do this, then move on to creative writing. No slight at authors. I have great respect for some authors. I enjoy their works and learn from them. They can craft masterpieces, which is something I don't think I can do. My hat goes off to them. But these authors, as far as I know, are not technical writers. They do their thing. I do mine. We are just different. There's no comparison. As writers, we just have our own place in this world.

Writing For Others


As a technical writer, you are documenting something for another person.  It's about using your writing abilities to help them. You put your desires and agendas aside for your audience.

One of the first steps to writing a document is understanding who is your audience. Knowing your audience is the foundation in technical writing. If you don't serve your audience well or don't care at all, then the document will reflect that. Technical writing wouldn't exist if we had no audience to serve.

As a technical writer, you get no credit from the audience or even from the organization you are writing for. Almost always, there's no byline. You are basically a ghostwriter for the organization who wants to reach out to their audience. You do the work and they get the credit. That's how it is. Is it unfair? Yes. But remember: It's not about you!

I'll get into this more later on.


This Reluctant Calling Changed My Thinking


But first, I have a confession: I hated the idea of being a technical writer. Many years ago, I tried my hand as a journalist. I was told numerous times by editors journalism wasn't for me. They said I would be better suited as a technical writer because I wrote in a dry and matter-of-fact prose.  When I heard this, I was insulted. But this "insult" made me take a look into the mirror as to why I was writing in the first place. Unfortunately, I was writing for the wrong motives. I wanted my name out there and wanted to glorify myself. But God had other plans. After my fruitless pursuit in journalism, I reluctantly went into technical writing and the rest is history.

It used to bother me that I didn't see my name on a user manual or a brochure. It wasn't until I realized technical writing wasn't about me. It's about others. When I realized I wanted to help others through my writing, I was able to fully embrace this, quite frankly, weird form of writing.

Wear This Freakish Badge with Honor


Authors, such as Kurt Vonnegut, had keen insight about technical writers. Vonnegut aptly describes this strange form of writing:

"... technical writers are trained to reveal almost nothing about themselves in their writing. This makes them freaks in the world of writers, since almost all of the other ink-stained wretches in that world reveal a lot about themselves to the reader."

Though you don't reveal anything about yourself when you write, you use your writing to impact countless lives. You help those you may never meet by showing them or how to do something or informing about them some vital (maybe life saving) information. You may never know who you helped but you've helped them nonetheless. So wear this freakish badge with honor. And, stay humble as you write along.
 

Abandon Greatness and Seek a Servant's Heart


This may be contrarian when I say this: But to be a good technical writer, you must abandon any hopes of greatness. Rather, seek a servant's heart. Greatness and technical writing don't go together. When I mean by greatness, I don't mean great work. You should definitely strive to write a document well. What I mean by greatness is the potential prestige and fame like of a best-selling author or some well-known journalist. Sorry, it just doesn't happen with technical writing.

Technical writing is neither prestigious nor great. It's hard work where you get no substantial recognition for it. Others, like the big-wigs, get the credit or the fame while we remain in the shadows, faceless with our heads down typing away. And that's okay, let them bask in the glory. (Besides, if something goes wrong, they will get the brunt of the dissatisfaction.)

We are simply here to serve others. But don't forget: If you do this well, your writing has lasting, helpful effects on others more than the fleeting praises of fame and momentary pats on the back.

So which is better? Knowing you made a difference somewhere to help someone (maybe even saved someone's life) or hoping to get recognition and fame from others.

Knowing human nature, why would anyone want to fall prey to the Sirens called Fame, Recognition, and Prestige. One moment, the people sing you praise, heartily pat you on the back, and place you on a pedestal. The next moment, when you're enchanted with their song, they wedge a sharp, ugly blade deep into your back, twist it, and break it off at the hilt, and howl for your downfall. Then, proceed to slap you off your pedestal, where you fall to the ground and shatter into pieces. Then for the big finish, they jump on the shattered bits till you're nothing but powder.

I'd rather seek a servant's heart. For myself, I know God sees this and others get help they need, even though I rarely get a thank you for it. It gives me satisfaction I helped somebody, even if they don't know who I am. And if they saw me, they may say who's this schlub but that's okay. It's not about me. So, let me leave you with a snippet from the Gospel of Luke about how this world has it upside down.

A dispute also arose among them as to which one of them was to be regarded as the greatest.  But he [Jesus] said to them, “The kings of the Gentiles lord it over them; and those in authority over them are called benefactors. But not so with you; rather the greatest among you must become like the youngest, and the leader like one who serves.  For who is greater, the one who is at the table or the one who serves? Is it not the one at the table? But I am among you as one who serves."  — Luke 22:24-27 NRSV