- A workaround is a procedure designed to overcome a shortcoming of a program or piece of equipment.
- Sometimes the tools dictate the format of your work
- Projects tend to go better if you have a plan (believe it or not)
- Take the time to talk to the people on your project
Beating the system
Workarounds are common in the world of technical writing. They are the clever little solutions that you come up with because the program won’t do what you need it to do (hack is another term for this). In many cases, a workaround is needed because the program has a flaw. It is supposed to work a certain way, but it doesn’t. In other cases a workaround is needed because you want to make a program do something it was never designed to do. Workarounds aren’t just for hardware and software, they are for any situation in which you need to circumvent the established system. Workarounds are useful, and sometimes necessary, but they are never as good as a system that does what you need properly, and they are rarely supported.
After the success of the programmer’s reference, I wanted to put out a user’s guide. Of course, many of the problems that plagued my first attempt still had not gone away. I had no one telling me exactly what they wanted, and I still wasn’t sure what each report did or who it did it for. What I did have was the ability to take screenshots (images of the computer screen) and walk people through the process of filling out the pages needed to run the reports. I also had the information about what the output of the reports would be. By working with the main program (The main program was AMISYS and the report programs were custom written using SpeedWare) I started tracking down the variables as they corresponded to the report requests. This gave me some idea of what a user would enter.
Talking to people would have helped
Had I been more inclined to seek out the requesters and interview them, I surely would have come up with better information, but I was an introvert (according to my Myers-Briggs personality test I am INFP). The idea of tracking down strange people for information gave me an uneasy feeling with roots going all the way back to my daily beat-downs from schoolyard bullies as a kid (which thankfully ended when I grew to 6-1, 200 pounds by my freshman year in high school). My early days had taught me not to view strangers as friends, so I generally didn’t like to meet new people.
No one ever came along to ask how the project was going. Very few people, it seemed, had any understanding of what I was doing. The only people who showed any interest in my at all were the contract programmers. They would at least look at what I had written and offer advice, but none of them had a real stake in the outcome of my project. They were dealing with their own issues. Issues that I would soon get caught up in.
A simple plan
In the end, I came up with a simple format for the help. I documented each report with the following information (or as much of it as I had):
- Name of the program
- File name for the program
- Short (one sentence) description of the program
- Screen shot of the first screen
- Long description of the program (about a paragraph)
- Step-by-step process of filling out the fields
- Additional screen shots as needed for the process
- Description of the output
I’ve learned a few things over the years, and I’m sure I could come up with a better plan today, but at that point I was just happy to have a plan at all. This was a system that could have worked in Microsoft Word, although it would have been ugly. Microsoft Word does funny things when you add graphics. It tends to lose or move them, and it slows down dramatically. I had been pushing the company buy me FrameMaker for months (by this point I had grown to believe it could fix any problem), but the new FrameMaker required Windows 95 or Windows NT. The company eventually made the upgrade, and gave me my software, but by then I had a whole new set of problems to deal with. The work environment was about to change dramatically as I faced twin mergers, a new platitude-spouting manager and a programmer who hated my guts. Plus, I was about to say the word anal in front of the wrong crowd.
- The 16 Personality Types by Linda V. Berens and Dario Nardi: A lot of people have made a lot of money telling people who they are.
- Make Your Own Pocket Duct Tape Dispenser by Brad Isaac: An excellent example of a workaround.
- How to Take a Screenshot in Microsoft Windows by wikiHOW: It’s actually pretty easy
- What parts of your personality get in the way of your success?
- What are your tips for planning a project?
- Do you have a favorite workaround?