Adobe Robohelp

Get new posts delivered straight to your inbox.

Subscriber count: 3,220

Adobe Robohelp

Top 10 Workspace Configurations for Technical Writers

Feb 15, 2008 • general

dual monitorsHere's my list of the Top 10 Workspace Configurations for technical writers. (By "workspace configuration," I mean the characteristics of your work environment that make you most productive and happy.)

  1. Dual Monitors. Allows you to put the application you're documenting on one screen, your authoring tool on the other. No more scrunched windows or frustrations with constantly maximizing and minimizing your screens.
  2. Laptop with docking station. Gives you mobility of workspaces. For example, this morning the train stalled for 40 minutes, but I was working on my help file anyway. I don't even have a work desktop -- the laptop with docking station combo is perfect. It's like having both a desktop and laptop, but having their files always perfectly in sync.
  3. VPN connection. Essential for connecting to the Intranet from home to access the application you're documenting. Especially when you're trying to meet a tight deadline, VPN can help save your bacon as you work late into the night.
  4. Enterprise-integrated BlackBerry. My favorite new toy. Tonight I had a quick thought about improving the usability of an application while waiting for my wife to pick a movie at BlockBuster, so I thumbed an email msg to the PM and other team members. I've also just loaded my BlackBerry up with tech podcasts to listen to while I'm going to work. If I'm away from my computer for a while in meetings or at lunch, I won't experience that eerie feeling of disconnect.
  5. Open tool office policy. "Use the tools you're most comfortable with to produce the needed help materials." Freedom of tools is a writer's dream. It gives you more responsibility and ownership of your toolset, since you chose it and it wasn't forced upon you. It also allows you to author in the most comfortable environment for you.
  6. Google Talk as the IM Client. IM avoids the dozens of pointless messages you get daily that shouldn't be emails. IM is quick, and Google Talk is one of the best (and free).
  7. SharePoint 2007 platform for publishing help files. I set my publishing target in Flare to automatically push my help files to a SharePoint directory. Because it's SharePoint, I can update all help information on the fly, and I'm not restricted to the developers' code freeze and hardening deadlines. This removes a lot of pressure, and I know that if I later discover an error, or want to add more material, I can adjust the production help within seconds. April Update: After more experience using SharePoint as a file repository, I no longer recommend this method. SharePoint is not a stable platform. It's loading speed fluctuates, and if you have 20 MB videos, they don't load at all. SharePoint is like a Pinto for performance. You need a stable, robust server instead. Trust me on this one. Also, the anonymous access feature is also problematic. It can cause your entire server farm to crash.
  8. Proximity to project managers and project team members. As I said in a previous podcast, proximity to people with key project information is one of the best ways to get the information you need. If you're remotely located, or if your project team is scattered across different floors and department buildings, camaraderie and communication will go downhill. In contrast, proximity opens up the channels of communication.
  9. Open access to Pandora, Yahoo Music, or other online radio. Music helps me focus and blocks out random voices of people yakking away in the hall. I especially love Pandora because it's free and doesn't have audio commercials. It also loads almost immediately and begins playing.
  10. Ubiquitous wireless connectivity. A laptop's wireless capabilities can give you incredible freedom when your entire building has wireless access points on every floor, in every conference room. You can take your laptop to meetings and still be productive.

**Bonus configuration: A manager who reads your blog and who also blogs. This seemingly small gesture yields big returns in workplace rapport.


Get new posts delivered straight to your inbox.

Subscriber count: 3,220

About Tom Johnson

Tom Johnson

I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include technical writing, authoring and publishing tools, API documentation, tech comm trends, visual communication, technical writing career advice, information architecture and findability, developer documentation, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here.