I'd Rather Be Writing » project management

New Variables for Technical Writing Project Managers: Larry Kunz at the STC Summit in Dallas, #stc10

Tom Johnson — Mon, 10 May 2010 03:47:37 +0000

In this video, I interview Larry Kunz about new variables for technical writing project managers. Larry talks specifically about the ways agile and social media are changing the way technical writers manage projects. We recorded this video at the STC Summit in Dallas. The next day, Larry received the President’s Award at the STC Summit for his work with strategic planning. (I didn’t know it at the time we recorded the video, or I would have asked him about it.)

Blog Sponsors

Have Notebook Will Travel

Tom Johnson — Sun, 29 Mar 2009 13:50:30 +0000

This is a guest post from Collin Turner about staying afloat as a technical writer in an agile environment.

When the sound of my Outlook calendar groaning drifted across my office I knew I had fifteen minutes to prepare for a rapid-fire succession of meetings that would last three hours … the “Agile Gauntlet.” It was a daily occurrence and a price I willingly paid for the opportunity to write documentation in a functional Agile environment. Survival consisted of a few barebone rules:

Adopt a GTD (Getting Things Done) system that’s fast, dead easy and only as complex as the tasks it contained. I ended up using Evernote with my camera phone* to get snapshots of Whiteboards, Microsoft OneNote to catch bullets (and drop the pictures into the appropriate meeting) and a Moleskine notebook for those ever important “paper” moments.
Ditch the desktop computer and go for an adequately powered laptop that you’re comfortable carrying around. Make sure you’ve got a good battery and wireless connection.
Use your time and resources to build strong working relationships with developers, engineers, project and product managers. You are not necessarily a member of a specific team … you are ghost haunting all of the teams. Try to be a friendly ghost and leave the poltergeist tactics for those moments when they’re absolutely necessary. In the follow up meetings, ask if you can use a voice recorder. It helps keep concepts fresh and separate.*
Set aside a location where you can write, edit, and revise in relative peace. This can be your home, an empty room, bathroom stall, your car … wherever. If you don’t do this, you will go insane.

The meetings were a frenzied walk around of fifteen minute stand-ups between 12 working development teams. I listened, took notes, asked questions, and scheduled followups if documentation was due for specific teams in the current iteration and more information was required. Those fifteen minute pearls became crucial planning and development points for core documentation. After the meetings I solidified my notes by re-writing the pieces most critical to me in the current iteration. Each team meeting note went into that team’s folder and any documentation was updated accordingly. It became a process that moved quickly and kept me organized, important when considering the amount of information 12 different teams can produce in a short amount of time! Since the walkarounds were usually scheduled in the mornings, the rest of my day could be dedicated to followups and writing. Once a week we usually scheduled Iteration Planning Meetings where my documentation was scheduled for each team. This gave me the road map needed to navigate upcoming tasks and plan accordingly. I hope you see the emerging theme here. Organization. Obsessiveness is not required to document Agile teams, but dedicated organization is. If it gets away from you once, it’s twice as hard to wrangle back into focus. Work in broad strokes first, chisel away until you’ve created manageable chunks. You’ll be amazed at how easy Agile becomes once you’ve broken it down to simple tasks and follow the process. When your documents are ready for detailing? That’s when you find the “quiet place” and focus on the fit and finish. Add and polish the details but remember that your working in Agile. Your documentation is fluid and will change, often. Make it fit the requirements of the iteration, but don’t worry about making it the last word unless the project is over. One piece of parting advice? Communication with the teams is as important as anything else. You’ll find many developers and engineers who don’t see documentation as a crucial piece of the process. Don’t fight them or try to convince them otherwise, the time you spend in battle will just eat your iterations and create resentment. Work with them, ask questions, listen, and let them explain their work. Assume nothing and learn everything. This is the key to integrating yourself as a vital member of their team. They will start coming to you with questions and important facts. You will gain allies and Subject Matter Experts — priceless commodities in any Agile environment.

About Collin Turner Collin is a technical communicator, sometimes author, editor, and photographer usually found deep within the workings of APIs, writing manuals or managing projects. He lives in northern Utah where you can find him out among the mountains or online at www.collinturner.com. Collin is riding out the recession by documenting the hardware industry.

Blog Sponsors

Going Beyond Technical Writing: Practical Advice for Diversifying Your Skillset — Podcast Interview with Mark Hanigan

Tom Johnson — Tue, 29 Jan 2008 04:44:34 +0000

Download MP3
Duration: 35 min.

In this podcast, I talk with Mark Hanigan, former international STC president, about ways to go beyond technical writing. I knew Mark at the STC-Suncoast chapter in Florida and often, during “post-meeting-meetings,” listened to him talk about ways to transition from technical writing into tasks that companies perceive as having higher value, such as business analysis and project management.

Mark strongly believes that technical writers often sell themselves short. Given our skill set, our attention to detail, and our comprehensive understanding of the applications we document, we become de facto SMEs who can deliver more than just a software manual. We can create business requirements, contribute UML diagrams representing workflows and processes, create computer-based training, influence business methodologies, implement content management strategies, present training and e-learning courses to users, help meet regulatory standards, and more.

In many companies, writers who stick with writing-only tasks quickly become outdated, as IT departments begin to perceive documentation as a commodity that can be outsourced. Mark talks about ways to diversify your skillset, wear many hats, and bring more value to the company.

He also talks about the essential quality that technical writers must have today: an ability to embrace change, to adapt and learn new technologies. This is, he explains, one reason for his abiding involvement in the STC: instantaneous access to colleagues who share information about the latest tools and technologies they’re using.

About Mark

Mark, an STC fellow and former international STC president, is a frequent presenter at conferences, including the STC Conference. He is currently a member of the Suncoast and Orlando chapters in Florida. To contact Mark, send him an e-mail at OnWriteTrk@aol.com.

Special Announcement from STC-Atlanta

The Society for Technical Communication (STC), Atlanta Chapter is pleased to announce the Currents 2008 conference on March 14-15, 2008 at Southern Polytechnic State University, Marietta, Georgia campus.

Currents provides a great opportunity for technical communicators to expand their professional skills and to network with peers. The conference is open to any technical communication professional regardless of skill level or position. We also invite other professionals who are interested in the technical communication field. Join us to expand your skills, network with other professionals, and have fun with friends.

Learn more about the Currents Conference.

Podcast Sponsors

MadCap Flare is the most versatile XML-based Help authoring tool on the market, with thousands of customers using MadCap products including Microsoft, Google, HP, GE, yahoo and the list goes on. Check out Flare version 3.1 and a host of other new tools at at madcapsoftware.com.

Lunar Pages offers basic web hosting starting at $6.95. When you sign up for a basic hosting account, you get 350 GB of storage, 3500 GB of bandwidth per month, free tech support, Fantastico, and and dozens of other tools. If you’ve been thinking about starting your own self-hosted blog, contact Lunarpages.com to set it up.

Adobe – The Technical Communication Suite software offers a complete solution for authoring, managing, and publishing interactive instructional information from technical documents and books to online help systems, knowledge bases, interactive training, and eLearning content in multiple formats and languages. Learn more here.