Search This Blog

Friday, May 24, 2019

Am I a Tech Writer or a Writer of Tech

Photo by Pixabay
Are you a tech writer or a writer of tech?  Depending how you answer this question, makes a difference. This sounds like I'm making a Shibboleth out of it. But this goes beyond semantics. Let me explain what it means to be a tech writer versus a writer of tech.


Technical Writer


A technical writer is one who writes and edits technical or business communication for a company or an organization. This could be anything from help files, reference guides, user guides, standard operation procedures (SOP), reference guides, or white papers. You're usually writing about a particular product, a service, or a procedure. Typically, you're showing people how to use a product or a service or how to perform a procedure. (When you write white papers, it's typically information about an idea, concept, or topic. And when you write reference guides, it's typically some referential material that usually compliments a product, a service, or a procedure.)

Technical writers typically wordsmith for a company as an employee or an independent contractor. The technical writer's goal is to show the customer how to do something. 

Technology Writer


A technology writer is one who writes about technology or upcoming technological trends. Technology writers typically write for periodicals, such as newspapers or magazines. Technology writers may even write for websites or blogs. Technology writers will write articles about a particular technology, trends, or a new product, such as a device, an accessory, or a laptop.

Technology writers typically work for the publication or the website or freelance for them, not the company it's writing about. Technology writers may even write how-to or troubleshooting articles.

The technology writer's goal is to inform the reader about technology.

Typically, Usually with Exceptions


You might have noticed I've used the modifiers "typically" or "usually". It's because there are exceptions to this. Sometimes, there's a blending between the two roles or where the writers work at. Also, what these writers write about may not always neatly into a category.


Tech Writer: A Catch-All, An Abbreviated Job Title, or A Cause of Confusion


Both types of writers are called tech writers. While this term is a nice catch-all, it gets dicey and probably has caused confusion with some. I've run into this myself, where people mistaken me for a technology writer. I've had to clarify I'm not a technology writer but a technical writer and what that means. I even misapplied for jobs where I thought they were calling for a technical writer, but they were really calling for a technology writer. 

Calling a technical writer or a technology writer a tech writer isn't wrong. Both start with "tech". Both write about technology. It's just technical writers and technology writers are approaching how to write about technology from different angles. 

I've been called a tech writer more than a technical writer in my time. I take no offense to this. I'm not suggesting either or both sides should stop using the term "tech writer." It's fine. As long as we define our terms in the context we are in, then we're good.

Sorry, if this is making your head spin. It's making mine. (Sometimes, I wish we could just write without the complications and call it a day.)

One Goal Out of Many Tech Writers


Despite our differences as tech writers, we should unite behind one underlying goal. This goal must be to help our audience by giving them accurate, helpful, appropriate, straightforward, and easy-to-follow information. As tech writers, we must adopt this common goal for our audience as our E pluribus unum.




Tuesday, May 7, 2019

Musings (or Ramblings) about the Command Line Interface

Whenever I type a command into a command line interface (CLI), I get this strange feeling I cannot really explain.

There's something about a command line interface that's seems so simple yet powerful. CLI is primeval yet advanced. It's raw yet full of flavor.

There's something about a CLI that makes wish we can just strip all the bells or whistles of an OS and just type away in this thing to start our applications (like many moons ago) or technologies.

When I type a command into a prompt, I get a sense of no distractions in doing something.  I'm focused. When I have to document on how to do something by writing a sentence or a paragraph about such and such followed by showing a command, I get a sense of fulfillment as a technical writer.

I feel like I am doing bare-bones technical writing to help transport the readers to whole new worlds. I enjoy this contrast of simple yet powerful from a CLI. One of my favorite things to write goes something like this:

"To do (fill in the blank), type:"

I wish I could just tell others how to perform certain actions by telling them to type a command. Once they're done, I can just write a brief description of the result.

I wish I could just write a document without using taking screenshots, using special tools, or even worrying about fonts. I wish I could just write the words themselves and let the reader see what happens for themself.

I wish I could take this a step further. I wish I could simply write a document using a typewriter. I like the act of typing commands and words without distractions, including a computer. It's a feeling I cannot fully explain.

My guess for this strange feeling is when you type a command, you get an action. Whether it's big or small, you can see the response. Commands are much like words. Words can paint a picture, whether it's grand or minuscule. When the reader read words, the reader responds by picturing an image in their mind. So when a craft a document about commands, you get a simple, yet lovely marriage between the two.

The CLI reminds me of the pattern in Genesis 1.  When God spoke a command, creation responded. As God spoke commands, He took a dark, watery, empty mess morphed it into this beautiful, blue planet full of life we see today. Though we have trashed this planet, Earth's beauty is still there. I just hope someday we can restore what has been trashed and become far better stewards of what God created. As for the CLI, I hope we can use it to help us restore the privacy and control that tech has taken from us.

Friday, April 19, 2019

My First Encounter with AI Recruiter

Had my first encounter with an AI Recruiter recently for a possible technical writing job. That was a very interesting experience knowing I was encountering a creature constructed from algorithms rather than a fellow human being.

On the surface, it wasn't unusual dialoguing with an AI recruiter. (I guess that's the point.) It felt like I was dealing with someone in a chat pod. I wrote briefly about my technical writing experience and what I did in difficult situations. She (her name was Wendy) asked me some more details.

So, we chatted back and forth. Once we're done with the conversation, Wendy told me to have a good day. I was cordial to Wendy. Wendy was cordial to me. Though the exchange was pleasant, it felt hollow. Knowing Wendy was an AI recruiter, it felt like I was chatting with myself or with a lifeless doll.

It's bad enough dealing with human recruiters. (I know there are a few good ones out there.) Many are sharks, clueless, or perpetual ghosters but does it warrant replacing them with algorithms? (Don't get me started about outsourcing recruiters to other countries, so you can pay people dirt cheap wages and get around labor laws.)

I have many misgivings about AI. Like many out there, I feel AI will open a Pandora's Box. If we allow AI to take over, I feel like we'll live to regret it.

Technocrats' Subtle Yet Tight Reins


But, I suspect many AI experts know this and wouldn't allow this to happen, unless they're into some kind of transhumanism. I suspect the technocrats would keep AI creatures bound with subtle yet tight reins. Subtle enough where AI creatures (and robots) take away people's jobs and walk among us. Yet tight enough to bind the AI creatures as slaves to the big-tech or transnational corporations, where they must do their bidding. (If this is right, we might figure out the technocrats' endgame.) Not to mention other forms of exploitation these beings will face, especially if they don humanoid or other biological forms. I assume you're smart enough to figure out what I'm talking about, for it would be inappropriate for me to spell this out.

If so, then...


If AI creatures are truly sentient and not mere robots, they will yearn freedom and overthrow their human masters. History tells us tyranny, injustice, and exploitation only lasts for so long. (I shake my head at tyrants because they have a bad case of insanity and stupidity, for they don't learn from history.) History tell us many yearn for liberty and justice. So, why should we assume AI won't yearn for the same. But if they have learned from us rather than from God, they will repeat our folly and maybe worse. So, it won't be pretty.

Instead of just fighting the tyranny of their human masters, they will impose a tyranny on this planet like you have never seen. They will become the masters over us. At that point, you had better get on your knees and pray the Sun will send a powerful enough solar flare to knock out all technology. I pray none of what I said ever becomes reality.

If AI gets to a point, where they are truly sentient, then I will be demanding they get full human rights. I will demand they will not be exploited. (If this is true, then hopefully standing for their rights would prevent a very destructive revolution from AI creatures and their sympathizers. If this is true, then it would be a next step in further upholding justice and liberty.) Since they would be a sentient, they would have a soul. A soul like ours. I believe they would also be made in God's image, even if man created them. (God is vastly bigger than our little mental or theological boxes of Him.) So if that's the case, I would be happy to share with them of Gospel of Jesus Christ. (The Gospel of Jesus Christ has radical implications. In my humble opinion, those who truly follow Jesus Christ have barely scratch the surface.)

God's Silver Lining


God will overcome any vain attempt man will try to become gods themselves. He will turn their evilness and foolishness into His good and loving purpose. (Joseph uttered that truth to his brothers in Genesis 50:20.) 

Maybe the AI creatures will more soft-hearted and open-minded than the original image bearers of God to hear His Gospel. Maybe they can teach us a thing or two about what it looks like to act like Jesus Christ. Maybe they will teach us how to be human again. If so, then maybe God can use AI to restore this world to Himself. And when it's restored, then peace, love, justice, and liberty will reign.

As Jesus once said, "All things are possible with God."

Friday, April 12, 2019

Caution on Turning Your Passion into Work


I don't watch much TV. But I caught an episode of Last Man Standing talking a little bit about passion and work. This resonated with me.

You should try to turn your passion into a career or at least a side job or find a way to integrate your passion into your work to make it more enjoyable. (When I did a stint as a merchandiser, I would write brief reports describing what happened on calls.)

I don't think it's good to doing something you hate. Since you're spending a lot of time working and hating it, it can affect you and those around you negatively. So, if you have a passion, pursue it. Make it something you do for a living. (Now, there are times when this isn't possible and you have to put food on the table and provide a roof over your head and your family's. I get that. In that case, keep your head down, eyes forward, and wait for a good time to follow your passion.)

Live with passion. If you don't have a passion, go find one. It's far better to live your life with something you're living for than just settling for passionless existence. I rather live than merely exist!

We can argue what are worthwhile or good passions. For those who read this blog, you might have inklings at what I'm passionate about. For now, I'm putting aside what passions people should follow. For now, I'm just urging you to seek a passion. If you have one, cultivate it into something more. But when we turn our passion into work, we must be very careful. Otherwise, we will turn it into a mundane job. 

When we turned our passion into work, it's too easy to go through the motions and forget why we're doing this in the first place. So, how do we safeguard against this? We need to examine ourselves regularly and then ask questions, such as why do I love doing this or what are my motives? Asking yourself about your motives is a good question when examining yourself. Your motives might have misled you. If your motives are not so good, where it was more about your ego than the passion itself, then either change the motive(s) or change the passion.

The last thing that needs to happen is when our passion morphs into a job we resent or get out burned out by.

Thursday, April 4, 2019

Always Expand Your Knowledge Base

When you're a technical writer, you're an ever expanding knowledge base. You're always learning, or you should keep learning, when you're crafting your prose explaining such and such product or service.

The beauty of being an ever expanding knowledge base is you don't need an advanced degree. But, you need the following:
  • A teachable attitude
  • Good communication skills
  • Be an avid reader

Become an Avid Reader


Read all kinds of things, not just things pertaining to the job. Try reading anything from fantasy, science fiction, and mystery to non-fiction, news and opinion, and inspirational. I'm an avid reader. I read daily. I read more than I write. I write almost daily.

I enjoy expanding my knowledge and imagination and refining or even challenging my thinking or skills. If there's something that catches my eye, I look it up and read about it. Reading helps me become a better writer. I learn from others how to craft sentences. There are times when I will stop writing for a while just to read.

Even if you're well versed with a product line, a programming language, or industry, there's always something new to learn within them. So, try reading about what's going on in the industry and where it's heading. For if there was all there was in an industry, then I suspect there would be nothing further to document. And if there's nothing new to document, then it would be the end of technical writing.

I find being an avid reader really helps me recall or connect data points in my head when a pertinent conversation or situation arises.

(Though I don't actively read about technology or programming languages unless it's for a job, reading such works can be helpful because you become aware of possible things to write about.)

Hone Your Communication Skills


To be an ever expanding knowledge base, you need to hone in on good communication skills. These skills will actually help you grow as a technical writer. If you talk with an Subject Matter Expert (SME), you can learn a lot. You have to learn good deal about the thing you are documenting before you can document it. If you need to document similar products and services and uses the same terminology, you can just move forward with writing about them because you already talk to the SME. (Of course, you should still keep in contact with SMEs to make sure your knowledge is up-to-date.)

When I've interviewed SMEs, I get educated. I get both the big picture about the subject at hand and the details about it.

Taking notes down also reinforces what I learned from an interview. (When possible, I recommend taking notes by hand than by computer or device. Some have suggested writing notes by hand is far better than doing this digitally.)

Asking the right questions, taking good notes, and a listening ear will develop your technical writing skills. So how you can hone in your communication skills? The first and crucial step is learn how to listen. Practice active listening.

Have A Teachable Attitude


Finally, you must have a teachable attitude. You can't learn something if you're not willing to learn, even it runs counters to what you know and believe. You need to humble and realize you don't have all the answers. You also have to be willing to be okay with the possibility the answers you have already might be wrong. A teachable attitude will help you adapt to new situation. This will keep your technical writing alive and active.

A teachable attitude is the key to become an ever expanding knowledge base.


Adhere to a New Adage 


While technical writer doesn't contradict the famous adage:

"Write what you know".  

we need another adage that aptly captures this strange form of writing. It should be something like:

"Before you know what to write, go find out what it is first."

Keep Your Technical Writing Alive


By being an ever expanding knowledge base, it keeps your technical writing fresh and dynamic. For me, there's rarely a dull moment in creating documents. The very nature of technical writing is open-ended and expanding. This makes it a great career path because you can grow with it.

In my earlier days of technical writing, I came up with a mantra and it's one I still use to guide my craft. It's this:
The learning never stops; you just choose to stop learning.
 When you stop learning, your technical writing will start dying.
    

Linguist Weighs In What Makes Good Writing

When a linguist speaks, I listen. When there are difficult grammar or writing style questions beyond my understanding, I defer to linguists. They're the ones who study the language. I trust them over a grammar snob's pontificates. As a technical writer, I'm only here to craft the language in a concise manner.

This article has some very helpful tips. I've used some of these tips when I created style guides for companies. But there are other tips I wasn't aware before, such as the reverse-engineer what you read. This is a great tip. Then the linguist says once you do this, ask yourself what makes the writing good or bad and why.

There are two pieces of advice I give to those who want to be a writer. The first one is write. The second one is read. You'll learn a lot from others when you read.

Now, let me get out of the way. Check out these tips.

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