Technical Writing, Documentation, and Training

404-873-4288

Tools

MS Paint can be very useful

I used to take Microsoft Paint for granted. I saw it every once in a while in the Accessories folder when I was looking for the Calculator or Notepad but never really used it. Then I starting using screen capture programs at work to take screenshots for user guides, manuals, online helps, etc. When I was on my personal computer, I had no idea how to take a screenshot without a fancy program, and then I finally remembered Paint. Since then, I’ve used it for screenshots, creating and editing pictures/photos, and testing.

Continue reading

Laptop Shopping for the Non-Native Speaker

Take a look at this picture of the keyboard on my Dell Studio 1558 laptop (shown above).  Notice anything odd?

Well, where’s Number Lock?  What happened to the numeric pad (usually shares keys with the 7, 8, 9, U, I, O, J, K, L and M)?  These keys are typically used to type alt code combinations for characters not represented in the English keyboard. A Spanish speaker like yours truly would use them to type the letter “ñ”, accented vowels, and the “upside-down” exclamation and question marks.

The first time I tried to use alt codes with the laptop I thought:  “I must be missing something. They must have come up with some hip new way to do it.”  But how?

It turns out that in their infinite wisdom, computer hardware OEMs have decided to start eliminating features that customers “don’t want” (specifically, the Number Lock and Scroll Lock keys) in order to replace them with things that we just can’t live without, like the Windows key, a disk ejection key, or a right-click menu key. Fortunately, my manufacturer’s support staff offered some ‘helpful’ alternatives like using the Character Map or changing my keyboard language anytime I wish to type a non-standard character.  Alternatively, they offered to return my ability to type accented characters in exchange for a ransom payment of $18.99 for a Targus USB numeric pad.

I still haven’t been able to decide if I’m more frustrated by the removal of a feature that I ‘don’t want,’ the support staff’s absurd ‘solutions’ to the problem that the removal of this feature has created, or the manufacturer’s complete lack of awareness of the message that it sends: “typing in any language other than English on your U.S.-market laptop will not be tolerated.”

So let this be a lesson: if you or your employees value the ability to type special characters quickly (whatever the reason may be), make sure you add the Number Lock Key to your list of features to consider for hardware purchases.  It doesn’t come standard anymore.

Do you know about Wikipedia’s Simple English?

I don’t know about you, but I’m constantly Googling anything and everything and I frequently end up on Wikipedia’s website. One day I was looking at all of the possible languages I could read an entry in and noticed “Simple English” was one of the options. I was reading about something complex and “Simple English” simplified the topic and made it easier to understand (you could say it’s a “red carpet” to the “English” entry).

Continue reading

It’s Time to Stop the PDF Madness

Often, the quickest way to get a document deployed is to write it in a Word doc, create a PDF, and post it somewhere for users to access. This happens a lot for both end user and developer documentation. So why, then, is distributing PDF files for online reading a top web usability gaffe? Continue reading

Why Bother Writing Requirements?

We’ve recently been approached by two different companies about writing requirements. The first, a small company, wanted to develop a dashboard to replace a third-party application it was using. The owner, who had most of the information in his head regarding what the new dashboard should look like, what it should do, etc., suggested we send one of our writers to his location to study the existing dashboard, spend a little time with him and some of his key people to learn more about the functionality the dashboard needed to support, and “capture” this information so he could give the requirements to a developer or offshore the project.

Continue reading

How Documentation Can Create Trust

When you are a company dealing with your customers’ most valuable personal information, you need them to trust you. One easy way to do this is to have your documentation flawless (or close to it). Also, performing a test run with a small group of people before releasing it to the masses is a good idea. The group of people should be 3rd party users who can find the mistakes you can’t find (since you’ve read and reread the form 40 times and never want to see it again).

Continue reading

Reading Images

There is an unfortunate trend towards using more images and icons and using fewer written instructions (I like to say “words”). Personally, I don’t think it’s obvious what every icon actually is and what it means, especially when I’m in a hurry to do something.

Continue reading

Do you know about Document Map in Microsoft Word?

Whenever I go through a Word document with clients and they ask where a section is, I always refer them to the Document Map. Frequently, they don’t know what it is. Do you know what it is?

In short, Document Map displays the table of contents on the left side of your screen. This is helpful when searching for sections in a document even if there is a table of contents (less back and forth). You just have to make sure your text has heading styles applied to it correctly.

To find it and use it, follow the steps below.

Continue reading

Finding Form Buttons in Microsoft Word 2007

Recently, one of our clients asked us to document the creating forms feature in Microsoft Word 2007. I’ve used Word 2007 quite a bit with another one of our clients and recently got Word 2010 for my personal computer. It seems a little crazy at first but easy once you get the hang of it.

Continue reading

Do Your Homework!

Recently, I’ve been attending lots and lots of meetings. I like talking to people, learning, brainstorming, smiling, etc. One thing that has been pretty consistent though is that people are not doing their “homework”. Teachers didn’t talk about the importance of homework in our 17+ years of schooling for nothing.

Continue reading