Categories
Documentation Language Writing

A Deep Dive into Technical Writing

As a writer – albeit these past 30 some years of technical topics – I believe words actually do have meaning and should be used carefully and correctly. So when I read recently in a LinkedIn post that a product manager had a “deep understanding” of his industry; or a post from my neighborhood email blast that a neighbor was looking to have someone do a “deep clean” of her house; or finally, that a webinar promised a “deep dive” into a topic; I knew something was amiss.

What’s up with all of these deep activities?

Why suddenly is an understanding of an industry insufficient that it now requires the adjective deep to make it somehow better? How does a cleaning of a house become more thorough by making it a deep cleaning? And a deep dive? Unless you’re discussing a scuba dive, what are you talking about?

The obvious answer, of course, is that corporate speak is to blame. People seem to need to misuse words to somehow make their lives more meaningful. Or something like that.

In technical writing, on the other hand, there is no “deep dive”. Or to put it another way, if you don’t know – don’t have a true understanding – of the technology you’re writing about, you’re wasting your time and, more importantly, the time of the poor person reading your useless work.

Because all good technical writing is a “deep dive”. To do less than that is not technical writing, it’s wordsmithing. And that is the biggest insult you can possibly hurl at a technical writer.

Categories
Business Documentation Process Training Writing

Importance of Documentation in a Pandemic

2020 has been one big, scary, and unforgiving roller coaster. The kind of roller coaster that you wanted to ride all of 2019 that you thought would be exhilarating, but once you buckled in, you realized you made a horrible mistake. The Coronavirus (the highest point of this metaphorical 2020 roller coaster) has impacted a plethora of small and large businesses, and in many cases has unfortunately shut many of these businesses down for good.

For the businesses that survived the seemingly never-ending upside-down loops that this roller coaster of a year has thrown at them, we have to wonder how they have managed to get though all of these changes. What resources do companies need to use to overcome the obstacles that this pandemic has brought upon them?

As someone who works at a FinTech company that survived and flourished during this pandemic, one of the most useful tools for our team members unsurprisingly had everything to do with documentation. Our company uses a software solution that provides a knowledge base that allows our team members to securely share easily editable policy, product, and company information, and give us access to new information as it becomes available. The virus changed many company procedures that were commonplace pre-COVID, and access to updated documentation was vital in making sure we were all “on the same page” and giving customers the correct answers.

Correct, easy-to-use, and up-to-date documentation is essential for any business, pandemic or not. Documentation allows for effective communication between teams and customers. Fewer mistakes are made and less misinformation is spread when everyone is informed about the correct information. Less time is wasted trying to find answers for a specific problem, resulting in a more efficient overall work flow and better customer experiences.

As we approach the end of this 2020 ride, it would behoove any business owner or company to evaluate where their company stands, and to see how documentation could improve overall success for their company and how to avoid paying the price of admission for any rides in the future.