Tag Archives: embedded help

The Computer Programming Humanities Major

When I first played with Excel in High School, I noticed an interesting little code feature tucked away in the macro section. People with experience in Basic programming can set up basic codes to perform macros and automated functions. Having at the time just completed a Visual Basic class I considered this to be a valuable tool to explore later on.

Then eleven years passed…

…and fast forward to last week when I found myself needing to perform a big spreadsheet edit. Put simply, for a column in a list of product rows I needed to insert a “Y” if the product in the row was over a certain dollar amount, and a “N” if it was less. Performing this task manually was a problem considering the spreadsheet consisted of over 16,000 rows.

After consulting the great and mighty Google I failed to find an obvious solution. Fortunately one tech help page suggested to someone with a similar problem to write a macro. I realized I could do something similar to automate the process.

Although I never got past basic Java (recursion killed me) before committing myself to the humanities, I remembered enough to come up with a basic If-Then statement which, after some tweaking, solved the problem nicely. Trying to remember Basic programming took some time, but it was much faster then trying to manually edit the spreadsheet myself.

Moral of the story? Having the “tech” in Technical Writer pays off.

For the record, the code I wrote is below. I’m pretty sure it was more complicated then necessary, but it worked!

Sub PriceCheck()

Dim Cell As Object

For Each Cell In Sheets(“mdd1”).Range(“AN2:AN16860”)

If Cell.Value > 500 Then

Cell.Value = “y”


Cell.Value = “n”

End If


End Sub

Leave a comment

Filed under Information Design, Technical Writing

Defining the “How” in “How can I help you?”

I discovered an interesting post from one of the technical writing blogs I follow during my Sunday morning blog catch-up. Technical communicator  Shweta Hardikar recently wrote a blog post pondering “embedded help” or, helping users solve problems without calling it help.

Although programs are constantly evolving and taking advantage of multimodal interaction, one important question remains: “how do I use this program?” Users want immediate results, they don’t like to read through 50-page user manuals and guides. Looking up answers takes the user outside of the program experience, ruining the immersion. And honestly, how many people actually bother to read or even keep the user manuals that come with programs? Although companies are getting smarter (and eco-friendly) with user manuals by storing them in the program or on a  CD, the fundamental problem of having to go outside the program remains.

That is where embedded help comes in. Embedded help integrates the help directly into the application instead of through an outside source. This often takes the form of text that appears directly on the application, or via an easily accessed button. Not sure what a particular option does? Instead of making the user look up that bulky/poorly accessible user manual, offer a button labeled “help” or “?” if you don’t like the idea of using the word help.

Not every section of a program requires embedded help. Indeed, the golden rule of maintaining simplicity should remain in effect. The key behind using embedded help lies in anticipating where the user might have a question. A handy accessibility rule for programs and vital for web navigation, especially if you are running a business.

When I create product pages for Medical Device Depot my supervisor constantly stresses the importance of clarity. I always have to anticipate where the customer might experience trouble when ordering a product, and provide necessary clarification through embedded help. If I don’t include this explanation then the best case scenario is that the customer calls and asks, an unlikely possibility. At worst, the customer won’t buy the product, or accidentally order an incorrect product. Suffice to say, none of these scenarios are particularly desirable.

Here’s one example: when purchasing an emergency drug kit the customer must input additional information. I use popup help buttons to help clarify necessary details just in case the customer is uncertain. This not only saves time and trouble, it may prevent the loss of a sale due to lack of understanding.

Examples of how embedded help directly assists a customer. (Click image to see it in full size)

Leave a comment

Filed under Technical Writing, Web Design