Your User Manual

As a technical writer, anything that mentions “manual” (or “documentation”, for that matter) tends to catch my eye. I suppose it’s an occupational hazard. But when I saw this post from my friend, Steve Jones, it made me take notice.

I’m reblogging this for my own personal reference as much as anything else. Suppose you had a set of instructions for yourself? How would it read?

I might try this exercise for myself at some point, but for the moment, read Steve’s article, and see if you can come up with your own manual for yourself.

Voice of the DBA

Many of us have spent time looking through manuals or the documentation for some software or product. I know I’m on the MS docs site regularly for work, and there is no shortage of times I’ve used various manuals to help me fix something around the house. We usually use a manual when we want to learn how something is supposed to work, or how to get it to do what we want.

I saw a post on a personal user manual that I thought was a good idea for some people, maybe many people. This isn’t a manual for how you should live your life or work, but rather, how others might interact with you. This manual describes how you work, what motivates you, stimulates you, what pleases you, and even the environment in which are most productive.

Whether or not this is something you might give to co-workers…

View original post 299 more words

Advertisement

Make time for your art

This pic above showed up in a Facebook meme, and it spoke volumes to me. To sum up my thoughts in only a few words, I’m an artist.

Okay, I suppose some context is in order; after all, I am writing this as a ‘blog article.

For the benefit of those of you who don’t know me, I’m a musician in my spare time. I started playing the piano when I was seven, the clarinet when I was eight, and I taught myself how to play mallet percussion and the saxophone when I was in high school. I grew up learning how to play classical piano, and I picked up a taste for jazz and classic rock along the way. I played well enough that I easily could have been a music major had I chosen to do so; alas, my parents wouldn’t let me.

I also started writing my own music when I was in high school. I started out writing piano compositions (think John Tesh-like new age piano music) without lyrics. One day, I said to myself, “what would happen if I wrote lyrics for my music?” The result was a song called If She Only Knew. I ended up writing more songs; you can hear many of them on my songwriter’s page (you can even purchase my music on the page or on iTunes). I still have more music that I haven’t finished recording (alas, trying to coordinate time with friends who can actually sing is a major blocker, not to mention that life happens), and it’s only within the past few years that I’ve started writing again, after a long layoff of many years (like I said, life happens).

When I first started writing, I was an isolated, naïve, and lonely kid who hadn’t been exposed to a lot in the big wide world. As such, much of what I wrote was stuff that was on my mind that I was unable to express in words. Music was — and still is — the perfect outlet for me; it enabled me to convey what I was otherwise unable to express.

The pandemic over the past few years has stressed me out in many different ways, as I’m sure it has for many people. Under these circumstances, it’s especially important to maintain your mental health; indeed, it was why I ended up in the hospital last year. We are not robots, so it’s important to maintain some kind of relief valve to release the pressure. This is a huge (although not the only) reason why the arts are important. (I could also talk about how art trains us to think critically and creatively, but that goes beyond the scope of this article.) The arts allow us to express ourselves in ways that we wouldn’t otherwise be able to in the corporate, business, and high-tech world.

Art can take many forms. For me, it’s in my music. For others, it can involve drawing, sculpture, painting, glass-blowing, creative writing, poetry, sewing, video production, theater, collecting, cooking, and so on. (You could also make the case that sports and athletics are an art.) You don’t necessarily even have to be good at it. I once got into a lengthy argument with a friend who said that a picture created with animal feces was not art. What he didn’t understand was that art doesn’t necessarily have to be good or tasteful; it just has to be something that’s expressed, even if it’s (literally, in this case) a piece of crap.

I think art is critically important (I’ve argued that we should be teaching STEAM, not STEM). It’s important for us to develop as well-rounded individuals. And it provides us with a creative outlet that we desperately need to release stress, especially in our current world that is full of it.

The #Coronavirus chronicles, part 23: Learning songs in a new language #COVID19

Before I get into this article, I need to direct you to a few other articles that I wrote, all of which are directly relevant to what I’m about to write. You will likely not understand some of the references in this article unless you read these other ones first (or are friends with me on Facebook, in which case you can skip these). Give them a read (or at the very least, skim through them), then come back to this one. Go ahead. I’ll wait.

Back yet? Okay…

This morning, a friend of mine PM’ed me with this: “it would be epic to see LOTD in Korean.”

I sent him back this reply: “challenge accepted!”

So, I looked up K-Pop songs, and I came across this video. I will freely admit that what caught my eye was the artist’s name (take a look!). I listened to the song, and as it turned out, it’s a really pretty ballad that’s relatively close to my own writing style. I might end up buying some CDs (yes, I still prefer buying CDs, even if I do rip everything to iTunes) from this artist.

I ended up using the first four lines for my Lyric Of The Day (and I’m posting this mostly for my own reference and learning purposes).

"나를 사랑하는 법은 어렵지 않아요
지금 모습 그대로 나를 꼭 안아주세요
우리 나중에는 어떻게 될진 몰라도
정해지지 않아서 그게 나는 좋아요..."
-- Roy Kim, "Only Then"

(If you’re dying to know what this says, here it is in Google Translate. And if you want to hear it, check out the video.)

I was never a fan of pop dance songs. When I first heard K-Pop songs and saw related videos, my initial impression was that K-Pop songs were primarily pop dance songs, so I haven’t given the genre a lot of thought. This video that I found changed my mind.

It got me thinking: what would it take to write a song that’s not in my native English? There is some precedent for this; probably the most famous example is Ritchie Valens singing “La Bamba.” It would be a challenge for me; I’m still learning Korean (although I’ll admit that I haven’t been pursuing it as aggressively lately), and I’m far from being able to read it quickly or being able to carry on a conversation. Nevertheless, the idea is intriguing, and one that I’m considering.

This idea is making me consider several things. First, it’s encouraging me to get back into my Korean language lessons. Second, it’s making me want to revisit my songwriting and MIDI recording endeavors. Third, it’s inspiring me to break many bad habits directly related to pandemic fatigue.

And, if nothing else, it’s sparked an interest in K-Pop with me. I guess I’m going to have to go buy some K-Pop CDs.

#TheBestOf… Bringing the world together by telling us about your special world

A wandering mind can be a dangerous thing. 🙂

If you’re a ‘blogger who’s looking for something to write about, read on. Perhaps this will give you an idea.

This afternoon, I was doing a mundane, household chore (specifically, I was washing dishes and doing some cleaning in the kitchen), and whenever I do mundane chores like that, of course, my mind tends to wander. So today, I decided to write about what my mind was wandering about.

I don’t know what sparked this idea — maybe it was because I had Andrew Zimmern’s Delicious Destinations on the TV in the background. First, a little background. As a first (or maybe it’s second — I never know how these things work) generation Korean-American, I tend to appreciate cultural diversity. I love experiencing cultures and traditions that are not my own. I enjoy traveling, and I wish I could do more of it (only the lack of time or money — usually both — and these days, the COVID-19 pandemic — keeps me from doing so). I have friends and family around the world — maybe not as many as other people who’ve traveled more than I have, but nevertheless, I have friends I’ve made either by friends I already knew who have relocated to other countries, people whom I’ve met through my association with SQL Saturday or other PASS-related endeavors, or through work or school.

I also thought about things to bring the world together. I don’t need to tell you how divisive the world is these days. A while back, I wrote an article about bringing the world together. I started thinking of a way to do that.

So with all that said, here’s the idea that my wandering mind cooked up.

Let’s say that you have a friend from a foreign country or culture — one that is not your own — over to your home area for a visit. You want to show him or her the best of what your culture or your home turf has to offer. What do you show or tell him or her?

Personally, I would like to show my friend everything that my home state of New York has to offer — New York City, Niagara Falls, the Finger Lakes, apple picking, the Adirondack wilderness, Buffalo chicken wings, the Baseball Hall of Fame, music, county fairs, festivals, historic sites, etc. There’s a lot here to show off.

So, I’ll write an article now and then (usually whenever the mood strikes me) in which I talk about something — whether it’s a place, an art, a sport, a food, whatever — that is significant to me, and I’d like to show off to a visiting guest. I’ll precede these articles using the hashtag #TheBestOf followed by whatever I’ll write about (e.g. “#TheBestOf… Baseball” or whatever).

Here are some ground rules for this project. The topic — whatever it is — is something special or unique to me that I think a visitor would appreciate. It can not be divisive, disrespectful, or disparaging — partisan politics, for example, is verboten — unless it’s within the context of something historically or culturally significant (e.g. Benedict Arnold’s role in the American Revolution, etc.).

And if you’re a ‘blogger and would like to take part, knock yourself out. The best way to think about this little project is to pretend you’re a travel writer describing your home turf or culture. I would enjoy reading about what makes your world special, and what you’d show off if I came over to visit. If you’d like, feel free to refer to this article for reference or context.

Let’s see how this goes. If you’d like to take part, great. If not, no worries. For all I know, this might be the only article in which you’ll see this hashtag.

Have fun!

The #Coronavirus chronicles, part 18: Exploring your backyard (and places to visit near Albany, NY) #COVID19

(Photo credit: U.S. Grant Cottage State Historic Site)

This morning, I saw a Facebook post from a friend of mine who visited the Ulysses S. Grant cottage. He posted about its historic significance, and included a number of photos that he took around the site. It was a neat post, and it made me want to visit the site.

I looked into it to see where it was located, and was surprised to find that it was just north of Saratoga — less than an hour’s drive from my home!

It got me thinking about traveling to places that are nearby. It’s been often said that some of the best places to explore are right in your own backyard. It’s especially important now with the pandemic restricting travel. My wife has complained to me about the need to de-stress and take some time off, and I’ve suggested doing a weekend (even just one night) up in Lake George — not too far from my home (it’s easily do-able as a day trip), but just far enough away to warrant a weekend.

It also got me thinking about what places are worth the trip for those who aren’t from around here. Granted, the Albany metropolitan area doesn’t exactly pop up on most people’s radars when they’re considering vacation spots or places to visit. Even I’ve been occasionally at a loss for words whenever friends ask me about things around my home that are worth the trip. But when I stop to think about it (as I’m doing right now for this article), there are a number of places around here to visit.

So, here’s a not-so-comprehensive list (really, just things that come to me) that are within an easy day trip from my home in the Albany area (including a few places that I’ve already mentioned above).

(There are probably a lot more things that I’m missing, but that would make for a very long list. This isn’t a travel ‘blog, and I am not a travel writer.)

What are some good places to visit in your own backyard? (Feel free to comment below.) If you’re itching to check some places out, go out and do so.

My company logo on a shirt

I was poking around VistaPrint‘s website the other day (this is the site I use to make my business cards). Of course, with any business that sells promotional items, I was greeted with the proverbial “try your logo on this product” popup window.

One of the items that came up was shirt designs. I decided to have some fun with it, and came up with the design that you see above.

I thought it came out pretty well! I decided to order two shirts, one for my wife and one for myself. I plan to wear it whenever I go to the gym and whenever I attend networking events, or events where I’m presenting, such as SQL Saturday.

If you like this shirt, you can order one, too; just click this link! I’m not getting any money for shirt sales. My payment is you walking around advertising my business!

Alas, I don’t yet have a large marketing budget where I can buy a hundred shirts and give them out for free. Hopefully I’ll get to that point, but I’m not quite there yet.

Coming up with ‘blog article ideas

Ever come up with a great topic about which to write an article? Do you have something on your mind that you want to get out of your system? Did you just learn something new and profound? Or is there some topic about which you don’t know but are trying to learn? Did you pick up some useful tidbit that you want to set aside for later use? Did you come across something you want to share?

I could keep going with this, but I’d rather not write a rambling paragraph that will eventually bore you; besides, I think you have the idea. I’d guess that one of the most common questions when trying to write a ‘blog is, “what do I write about?”

For me, personally, a lot of my ideas just pop into my head (including for this very article that you’re reading right now). If I think the idea is profound enough that it might help other people, I’ll start writing about it. Other times, I’ll come up with some idea, jot it down in a post, and save it for later. I have 100+ such draft articles; whether or not they ever see the light of day remains to be seen.

There are a number of things to consider when coming up with draft article ideas (and I dedicate several slides to this very topic in my ‘blogging presentation). If you’re trying to come up with things to write about, here are some thoughts that might help get you going.

  • What’s on my mind? It might sound obvious, but a lot of my ‘blog article ideas come from random thoughts that just happen to pop into my head. They’ll come from random sources — something I’m working on, something I’m watching, reading, or listening to, a question that someone asks, and so on. Every now and then, they’re thoughts that I think might help someone out. That can make great article fodder, so make sure you at least make a note of it. It happens more often that you might think; I’ve surprised myself at the number of ‘blog articles I’ve written that started as just random thoughts in my head.
  • I know something you don’t know — and I’m willing to share! Chris Bell, one of my friends on the SQL Saturday speakers circuit, once told me something profound, and it’s something I haven’t forgotten. He said, “an expert is someone who knows something that you don’t.”

    I’ve been a working professional for a long time now (I won’t say how long!), and I’ve learned a lot in my experience. I think I have some knowledge in at least a few subjects, and what I think can potentially help other people. Helping other people is one of my great passions, and if something that I know helps someone else, then I’ve accomplished something.
  • I just learned something new! Some people seem to have a misconception that you need to be an expert at something to write a ‘blog. Wrong! If you’re learning something new, keeping an online journal about what you learn is one of the best reasons to maintain a ‘blog! You’ll be able to see for yourself just how much you learn. Additionally, if you’re actively seeking new employment, it shows potential employers that you’re learning something, and that you have the ability to learn. Not only that, it shows off your expertise in terms of what you’ve learned. That’s something that hiring managers like to see!
  • I don’t want to forget this. Let me write it down. One of those people you could help is yourself. Matt Cushing tells a story in his networking presentation about the time he was trying to solve a problem, and he found the answer to it… in his own ‘blog! He had written an article about the very thing he was trying to solve, and found the answer in his article that he had forgotten about!

    As Matt says in his presentation, “a ‘blog can serve as your own personal Google.” A ‘blog can serve as scratch notes to yourself, and it might even help others in the process.
  • Bring people in. Don’t drive them away. You want people to read your ‘blog, don’t you? Like anyone else, I have thoughts and opinions about a lot of things, but I won’t ‘blog about a lot of them. I generally avoid any topic that’s divisive. You will almost never, if ever, see me discuss politics or religion on my ‘blog (I despise talking about politics, anyway). If I want to talk about religion, I’ll go to church. If I want to learn about politics, I’ll read The New York Times. Unless your ‘blog is specifically about those hot-button topics, they are more likely to drive people away than bring them in. I will not touch them on my ‘blog.
  • Avoid posting anything that is overly-sensitive or qualifies as “TMI,” unless it’s relevant to your topic. People generally don’t want to hear about your last trip to your gastroenterologist. Stuff like that isn’t typically what ‘bloggers write about. However, if some anecdote comes out of it — “my appointment taught me a lesson that applies to my professional life,” for example — maybe then, it’d be appropriate to write about it. However, be careful about it — make sure that what you write is appropriate for your audience. Nobody wants to read the details of your last trip to the bathroom while you had the bad case of diarrhea.
  • It’s okay to go off-topic once in a while. At the time of this article, Steve Jones of SSC is taking a sabbatical from his job (a nice little perk that he has available to him). During his time away from work, he has been ‘blogging about his daily exploits, which include skiing, learning to play guitar, and working around his ranch. I’ve been enjoying his posts, and I even told him that I was living vicariously through his posts.

    I’ll occasionally post an article that has nothing to do with my job, technical communication, or professional development. I’ll sometimes write about my extracurricular activities — my music endeavors (I play four different instruments), my workouts (I am an active Crossfitter), and so on. If you maintain a ‘blog about professional topics, it’s okay to post something off-topic now and then. It shows you have other interests, and it shows that you have a life outside of work. It shows that you’re human.

There are numerous other ways to generate ideas for ‘blog fodder. Feel free to comment below with your favorites. Hopefully, these thoughts are enough to help you get your own ‘blog going.

Blogging virtual presentation — Tuesday, January 21 @CASSUG_Albany @PASS_ProfDev

On Tuesday, January 21, at noon (US Eastern Standard Time), I will be doing my presentation titled “Blogging for Success: Advancing your career by blogging.”

If you’re interested in starting a ‘blog, I’ll talk about my own experience with ‘blogging and lessons I’ve learned along the way. Some topics I’ll discuss include how I got started, ‘blogging platforms, and subject matter.

For more information and to register for the event, use this link.

Hope to see you there (so to speak)!

A picture is worth (writing) a thousand words

On a recent project in which I was documenting an application, I found myself hitting yet another case of technical writer’s block. I sat in front of the screen, staring at the application — sometimes, for hours — and came to the realization that all I was doing was blankly staring at the screen. I tried different techniques to stir up ideas as to how to tackle writing the documentation, but no matter what I tried, the words just wouldn’t come. Even just trying to figure out a document structure — never mind actually trying to describe the application — was proving to be elusive.

It was at that point where I decided to give up on trying to write a description of the application functions and turned my attention to grabbing screen captures. I went through the application’s menu structure, built a document heading hierarchy based on it, and started working on the application images I’d just captured. I took the time to clean up the images, including altering them to eliminate any client or user data (replacing them with “dummy” data), and formatting them for my document. Once I was satisfied with the result, I inserted it into the document, proceeded to the next screen capture, and repeated the process.

A funny thing happened during this process. First, I found that my document was expanding in content. Granted, it was mostly graphics, but it was, nonetheless, content. Second, I’m finding it easier to come up with ideas for descriptions and text content. Third, I’m no longer blankly staring at my screen; I’m finding that I’m actually productive. Finally, I’m finding myself having fun with the process!

This is not the first time that I’ve performed this process while writing a document. Indeed, I’ve often worked on documents in which I found myself in a writing rut, shifted gears to work on graphics, and discovered the spark that I needed to write the text.

It’s an age-old saying that “a picture is worth a thousand words.” Most often, this phrase is geared toward the perspective of the reader. However, what is not as appreciated is that this cliché is applicable to the document developer as well. If ever you find yourself in a writing rut, try working on the graphics. It might just be enough to spark ideas and get you out of the rut.

First drafts are ugly

“The secret to life is editing. Write that down. Okay, now cross it out.”

William Safire, 1990 Syracuse University commencement speech

“No thinking – that comes later. You must write your first draft with your heart. You rewrite with your head. The first key to writing is… to write, not to think!”

William Forrester (Sean Connery), Finding Forrester

“Just do it.”

Nike

I will confess that this article is a reminder to myself as much as anything else.

Raise your hand if you’re a writer, and whatever it is you’re writing has to be perfect the first time around. Yeah, me too.

How many times have you tried writing something, but in doing so, you hit a wall (a.k.a. writer’s block) because you don’t quite know how to put something in writing? Or how often have you written a first draft, only to take a second look at it a second time and say, “what a piece of s**t!”

(And speaking as someone with application development experience, this happens with writing code, too. Don’t think that this is limited to just documentation. This is yet another example of how technical writing and application development are related.)

Someone (I don’t know whom) once said, “one of the stupidest phrases ever coined is, ‘get it right the first time.’ It’s almost never done right the first time!” In all likelihood, you need to go through several iterations — review, editing, rewriting, etc. — before a draft is ready for public consumption. It’s called a “draft” for a reason.

The fact is, nobody has to see what you write the first time around. If you’re trying to get started on a document, just write what’s on your mind, and worry about making it look nice later.