Think That Abbreviation Through

As a technical writer, I feel communicating well is the primary focus of my job. Perhaps this is why I found the following email exchange particularly comical today:

Email from <name deleted to protect the innocent … or not so innocent>:

Hey Will,

I have a question about the <xyz project>.  Do you know if the <important information> was added to the curriculum?

My response:

Hey <unnamed person>

Yes, I was able to add the <important information> last week.

Her response (not edited):

Thank you for the fup!

After my initial shock, I determined “fup” stood for “follow-up”, but this was not my first reaction.  I won’t share with you what I first thought “fup” stood for, but I bet you can guess.

When you’re trying to communicate something to someone in a business setting, I advise you really think about how someone might interpret your abbreviations before you send out that message.  I know in this day and age everyone likes to use shorthand and abbreviations because text messaging and tweeting limits the number of characters, but maybe we should keep our abbreviations to those forms of communication and out of email. 

Feel free to “fup” this post with your own comments on the subject :)

Comments

Making New Programs Easier: A Case Approach

It is often difficult to know what the priorities are when creating a successful new program. As a project manager for Shoap Technical Services, I have a fair amount of experience initiating new projects. Over the years, I have developed a few key “rules” for every project. While I could just go through my list and explain why I think each rule is important, I think it is easiest to learn through experience, so I have illustrated them through a case study of a recent project.

In October 2008, I was placed on a small project team at one of our clients to begin work on creating a training initiative for Work Management. Our client represents one of the largest energy-traders in the nation, with many of its power plants in the northeast.  Each of these plants operates by a Work Management Process, which is a way of detecting and successfully resolving problems or repairs.  Before today, plants would conduct training solely from a paper document that describes the entire process, supplemented by instructor-led training with a PowerPoint presentation.  I have highlighted some key points that have helped me through the process of creating this new training initiative.

Understand your objective.

Our client wanted my assistance in converting a 180-page document into an interactive, web-based training application that would be used by hundreds of employees within the company. The existing standard for online training at this company was a static and linear approach, using HTML with limited CSS to essentially place the contents of the document into web-based slides. 

Because of this, the client was very open to pursuing alternative options for delivering the training and suggested doing something more interactive.  Interactive web-based training creates a win-win scenario by increasing retention rates since the employees are more engaged in the content, and by providing a fun and memorable learning experience for the user.

While revamping the training program it was tempting to create new product guide videos or flash applications, but the interactive training program online was the objective. It was important to remember to accomplish that first, and only add the other things at a later time if these additions genuinely helped making the interactive web-based applications more useful for the learners.

Know your strengths.

I began working on this project with the understanding that I would be working with a very small team and was the designated “expert” since I had to simultaneously fill the roles of graphic designer, web designer, interaction designer, and lead developer.

There was much to be done on this project – there wasn’t a single piece of existing or reusable code anywhere. All of the graphics, web components, and interactive elements had to be created from scratch, and I was the one doing it.  Though challenging, these job responsibilities were easy for me to handle because of my strengths in both technical and creative fields, and I was able to offer many ideas due to my previous experience in IT training.  I doubt that without my help the client would have been able to accomplish this type of initiative. The lesson here is simple: Know what you can do on your own and what to outsource to someone with greater knowledge in the field.

Plan your approach.

First, I identified Adobe Photoshop CS4, Adobe Flash CS4, Microsoft Office 2007, and Microsoft Sharepoint Portal Designer 2007 as essential programs. Next, I generated a series of storyboards to allow me to quickly mock up different methods I could use while designing this project.  I had numerous mockups of the website design, user interface, and even some of the interactive elements of the training.  This made conveying ideas and approaches very simple and effective, and these materials gave me a better sense of where to begin. Finally, I established a reasonable timeline for producing a working proof of concept. 

Work around problems.

Even though I had named the Adobe programs as essential, I only was approved for the Microsoft products. I had to settle for Photoshop CS2 and Macromedia Flash MX 2004. Although I was disappointed because these programs are less effective for what I wanted to accomplish, I simply reworked some of my ideas to fit with the programs I had been given.

Execute your plan.

The project started off very smoothly thanks to the plan I had created. I created a Collaboration Team Site on a server running Windows Sharepoint Services, which would be the home for the training site.  Using the document’s outline, as well as Sharepoint Designer and Photoshop, I created sub-sites and a persistent left-navigational menu, providing employees with constant access to all levels of the site. Essentially, just get to work on what is in your plan and don’t worry about new things that may be harder than you intended. Until you run into a problem, don’t concern yourself with the possibility. That doesn’t mean to ignore foresight, but rather to only worry about things as they arise.

Be innovative.

A goal of this project was create a memorable experience in terms of user interface design and interactivity.  Presenting creative solutions to challenges can really go a long way to accomplishing this goal.

After reviewing the source document many times, my team and I realized that we should try to bring life to the many process flow diagrams within it.  These black-and-white diagrams contained the standard boxes, diamonds, and ovals connected by a mess of spaghetti-like arrows.  Diagrams such as these can be useful to an employee who is very familiar with the process, but to a new hire, there is always some degree of ambiguity or confusion.

Using my experience as a video game interface designer, I created a very innovative method of reinventing the process flow and making it completely interactive.  My initial approach was taking the employee on a step-by-step walk-through of the process.  Presented and completely custom scripted in a Flash movie, users see a low-level view of each step in the process on the left and, on the right see a high-level view of the entire flow, effectively a mini-map. The low-level view illustrates the progression through the process by showing a directional arrow going from one step to another. Users have the ability to dig as deep as they wish to learn about each step.   

I essentially took something that was always assumed to be static and made it dynamic and responsive to user input.  I successfully placed the learning experience in the hands of the learner, making for an interactive and engaging process. My innovation had transformed a previously marginally useful guide into something that was integral to training.

Make your work easy to adapt.

Recently, our project team decided we should make some changes to the interactive process flows, and this sent me into a panic. However, I developed the first set of process flows in such a way that many of the elements could be reused with little need for additional work. The process of constantly evaluating your work and adapting to the changing needs of the client really helps in driving your overall level of quality.  Having the foresight to develop your code or graphics in such a way that would allow them to be easily readapted in the future is a great strategy.  Incorporating principles of flexibility allows me to continuously be productive and still generate quality products in the end.

Comments

More Buttons!

Recently, I was working on a new Captivate project when I noticed that one of my go-to buttons did not show up in the drop-down menu with button styles.  Most of the projects where I used that particular style were created in Captivate v.2, so I assumed that the button styles were unique to that version of the application.

Wrong.

morebuttons.jpg

The button styles were all still there.  Just for some reason, Adobe decided that instead of putting them in the “Buttons” folder and making them available as drop-down menu options, they would put the old button styles in a sub-folder called “More.”  All you need to do to make the buttons visible in the drop-down menu is to move the entire contents of “More” into its parent folder.

Enjoy.

Comments

Captivate -ing Discoveries

error1.jpgIf you’ve just started using Captivate, the best advice I can give is the kind that should be printed in big, friendly letters on the front of every technology-related reference guide or manual… DON’T PANIC.  While there are a million and one reasons to use our favorite demo/presentation/simulation software, there are a few issues that you are inevitably going to have to deal with.  In the past I’ve written about consistent, reproducible errors that I’ve had to work around, but once in a while I run into something entirely new and unpredictable.

error2.jpg

After recording a demo today, I went back into the project to edit the auto-generated captions.  I checked the “Apply To All” options and then changed the caption style from Adobe Blue to Haloblue.  The default text size for both caption styles is 12 pts, but when I clicked OK, it changed all caption text to the Haloblue style… at 16 pts.

I undid the change, re-tried it on the same caption, and saw the same behavior.  After closing and re-opening Captivate, I could no longer replicate the issue.

So don’t panic.  Always reboot first.

Comments

Typeface Detectives Do It For You

I don’t have time to write yet another long post complaining about Captivate today, so I figured I would tell you about some useful font-matching tools that I’ve come across lately:

wtf21.JPG

  • What The Font? (above) - upload a sample image containing the text that you wish to analyze, and then confirm the characters shown in the image when prompted.  A few seconds later, WTF spits out a list possible fonts.  It was successful in identifying the font used for its own logo, so it is at least functional, but more extensive testing is needed - still, it is a useful tool to keep in your bookmark file.

fontthing1.JPG

  • Identifont (above) - similar to What The Font, Identifont will ask you around 15 questions about a font you are looking at and then take a guess as to what it is.  Didn’t have much luck with this one (got confused with Times New Roman) but then again I was only using a few letters.  I also can’t rule out user error since some of the questions were worded in such a way that they confused me.  I guess that’s what I get for being an “ESL” kid…

Hopefully these tools will make font-matching a little bit easier next time you need to do something like that.  Enjoy!

Comments

Careful With That Captivate Update!

Howdy folks! Hope all has been well since our last exciting installment in our ongoing Captivate entomology series.

Since my last post back in May, I’ve had the mixed experience of upgrading to the latest version of my *favorite* software package in the world. I would be ready to give our faithful readers a full run-down of the new features and enhancements in v.3, if it weren’t for the fact that I’ve been tied up troubleshooting what I considered to be a show-stopping issue with the new version: an apparent inability to capture full-motion recordings.

For the uninitiated, Captivate creates animations by snapping screenshots, stringing them together, and then animating mouse movements and typing actions over those captures. Since this approach does not work for things like scrolling and drag-and-drop operations, Captivate documents those types of actions by creating full-motion SWF recordings for the duration of the scrolling or dragging movement. But I found that this was not the case after upgrading. I was unable to capture full motion with version 3, no matter how hard I tried. Naturally, I tried reinstalling the software at first, and when that didn’t work, I followed all the recommended troubleshooting steps:

  • Tested with hardware acceleration disabled and then enabled - no dice either way. Everything that did not require full motion was captured perfectly, though.
  • Tried forcing full motion during a capture session using the F9 and F10 hotkeys… useless. Same results as above.
  • I even tried switching Captivate to Full-Motion Recording mode for the entire capture session. This left me with a single screenshot on a single slide… no full-motion slides.

Having exhausted all my options, I proceeded to pull my hair out for a few hours while scanning the Captivate forums on the Adobe site for issues similar to mine. While I didn’t find anything useful regarding my full-motion recording issue, I did see a lot of posts about a bug caused by the latest Captivate update where clicking into a text caption with formatted text would cause the caption to either lose all formatting or apply the formatting to the entire caption text.  Notice how the one below lost both the bold and italic formatting when I clicked in to edit it:

captivatebug3.png

Since this was caused by the latest update, I decided to reinstall and then stop the update process to see if that would resolve the issue.  It fixed both problems!  Without the update, I was again able to create full-motion recordings and edit captions without having to re-format them. But there’s a catch… Captivate does not allow you to turn off the updater, nor does it prompt you before downloading and installing.

nukeupdater.pngWell, that didn’t stop me. You can easily hack your way around this issue by opening the Captivate folder inside your computer’s Program Files folder (usually C:\Program Files\Adobe\Adobe Captivate 3\) and destroying the updater library (AdobeUpdater.dll). Just make sure you keep an eye out for the next update, which should correct the text formatting and full-motion recording issues. I’m not sure if they can be applied manually - if not, we will all need to reinstall Captivate to add the updater back.

Hope it helps!

Comments

Bride Of The Captivate Bug

Don’t have much time to spend on this post today but I thought I would put something up regarding some Captivate bugs that I’ve experienced recently, and how I’ve worked either with them or around them:

Click boxes that can’t do simple math

Captivate click boxes give you the ability to specify an action to perform when a user clicks outside of the box a certain number of times. While building a quiz-type activity, I thought this would be a good way to invoke an error message whenever the student clicked on not-the-right-answer enough times (I set it to 2 times). The error message would then take the student back to the start of the activity to try again. Well, it worked, except that after getting a wrong answer on the first slide and cycling back through to the same slide, the click box reacted to clicking on not-the-right-answer a single time (instead of twice, like I specified in the click box’s properties). I haven’t figured out how to work around this - if you did, tell me about it in the comments!

Control strips that refuse to leave

A while ago, I put up a post recommending the use of a control strip to speed up the debug process for a Captivate project. In retrospect, didn’t that seem too easy? It probably was… I have tested a few projects since then, and I’ve found that one of my presentations simply refuses to relinquish its control strip. I tried disabling it in the Skin Editor, but the only thing I accomplished with that was to make Captivate behave unpredictably in terms of rendering the presentation.

captivate1.jpg

Sometimes it would include a full control strip, and sometimes it would render the project with a blank gray area over where the strip should be, regardless of the settings specified in the Skin Editor menu.

captivate2.jpg

I’m not too happy to report that the only work-around I’ve found for this is to re-activate the control strip, disable all the controls on the strip, and then deactivate the strip again so that Captivate decides to include it during rendering, all the user sees is a blank gray space with an Info button.

    Anyway, that’s it for the bug report. Expect to hear from me again during the next few days as I document my upgrade to Captivate 3 - I know I’m way behind on this, but unfortunately I have to work with whatever the client provides. Anyway, I am looking forward to trading out all of the little quirks that I’ve gotten used to for a whole new set of bugs… bring ‘em on, and stay tuned!

    Comments

    Tiny USB Office Makes You A Word-Processing Ninja

    As a technical documentation expert, I pride myself on being able to get the most out of the simple tools that usually sit unused in most people’s Start menus. Why go through the trouble of setting up SnagIt just to capture a simple screenshot, when Alt + Print Screen and MS Paint will accomplish the same job at no additional cost?

    Well, SnagIt’s time-delay feature is pretty useful… when I end up using it once a month. Otherwise, the software just sits there on disk, accumulating virtual dust.

    This aversion to installing software, coupled with the fact that I have to re-image my test machine every few months means that I often need to generate documentation on a computer running nothing but an operating system. This type of situation is bound to affect anyone’s productivity, regardless of their level of MacGyver-ness. (Ever try to edit a .CSV file in Notepad?)

    So what is a technical writer to do when faced with such a dilemma? You’ve got some options:

    • You could lose an hour of your life installing and setting up a Microsoft product.
    • You could fire up Google Docs and most likely violate your NDA or your client’s security policies.
    • You could check out Tiny USB Office, dump it on your thumb drive, and never worry about this problem again, ever.

    Behold:

    ninja.JPG

    While there are more than a few Office-replacement packages out there that will fit on a thumb drive, Tiny USB Office is the first one I’ve used that covers all the bases with such a small footprint (2.5 MB!) It even does some extra things that you won’t find in Office, like password recovery, secure deletion, and PDF creation. Best of all, this stuff travels on your USB drive and runs directly from it, so you can take your work anywhere there is a Windows machine.

    Kind of like how ninjas always walk around with their katanas.

    Tiny USB Office

    Comments

    On Technical Writing Resumes

    The I’d Rather Be Writing techcom blog posts 10 Alternative Tests for Technical Writing Job Candidates. Not all of the ideas apply to our situation at STS, as we are all technical writers here, we don’t really have in-house documentation, and tend to recruit more entry-level folks who we can mold to our ways before they are corrupted by outside influences. However, there were some interesting suggestions.

    I like number 10, especially:

    Check to see whether the writer formatted his or her resume with styles.

    I look at the formatting of resumes, cover letters, and writing samples in detail before I read them. Seriously, folks. Your resume is a great opportunity to show that you have some grasp of good information mapping practices as well as some skill in Microsoft Word. (And as awful as Word is, most technical writers will be using it an awful lot.)

    Using styles gives you bonus points in my book. But if you don’t use styles, you should at least make sure the formatting is consistent. If some of your job titles are 10 pt. and some are 11 pt., I will notice. If you have two hard returns between some items and one between others, I will notice. If you use strings of spaces instead of tabs or paragraph styles to position your text, it will never line up perfectly, and I will notice.

    Lack of attention to detail is a deal breaker in a candidate, and a poorly formatted resume is a great big warning sign about your ability to spot those tedious errors that a quality technical writer must be able to spot.

    Comments

    Why Instant Messaging and Captivate Don’t Mix

    The client that I currently work for requires all employees and contractors to be available on a proprietary instant messaging system at all times during working hours.

    Unfortunately, mixing Captivate and instant messaging programs can cause issues with the auto-labeling feature during your capture sessions:

    image4532.jpg

    Not only can it get annoying when your captured slides show a callout for every time that you received a message, I’ve also found that Captivate 2 has a nasty tendency to crash about 50% of the times that an instant message comes in - this has cost me hours in terms of lost time and effort, so watch out! Of course, there’s no good way to tell if the issue is due to Captivate or the instant messaging app, but I suspect both of them are contributing. I’ve found a good number of confirmed bugs in Captivate when it runs by itself.

    I now make a habit (with my manager’s approval) of “dropping off the radar” and shutting off all applications whenever I am about to capture a Captivate simulation. I suggest you do the same.

    And hey, by shutting off Outlook you might just discover how much you enjoy ignoring e-mails.

    Comments

    « Previous entries