Top

How Technical Writers Gather Information: Attending / Holding Meetings

August 15, 2008 by J.C. Hewitt 

Information and CoffeeGood technical documentation comes from good information. Finding, understanding and explaining information is the job of the technical writer. There are many methods technical writers use to gather the information they need. This series will cover some of those methods.

Attend Meetings

Most meetings meander from dull to sleep-inducing with an occasional stop at tense, but showing up for planning and status meetings is important. The planning meetings give you insight into the thinking behind the product and the interface. Status meetings often alert you to changes in the product. When a project is running behind schedule (projects are never ahead of schedule) product components are often “pushed back” or “deprioritized”, which means you either don’t have to write the documentation for that component or you have to remove the documentation you have already written. Also, attending meetings increases your visibility in the group and allows you to get to know the stakeholders in the project. This makes it easier to talk to them when you need information.

Hold meetings

It is often a good idea to hold your own meetings. When you run your own meetings, you have the opportunity to gather the key people and get them talking about the product. I run a weekly meeting with my product’s stakeholders. I read through the documentation changes and give the SMEs (subject matter experts, pronounced smees) a chance to comment and request changes. The meeting is focused on information gathering and review. I tend to move through the information quickly because I don’t want to waste people’s time and because I am often heavily caffeinated in order to stay awake.

Meeting Tips

  • Whenever possible, give people the documentation or agenda in advance of the meeting.
  • Come prepared. Have the information you should have and know what information you want to come away with.
  • Have clear goals for the meeting, even if you aren’t the one holding it.
  • If you are going to be discussing the product/documentation in depth, record the meeting.
  • Bribe people with snacks.
  • If you are holding the meeting, make sure you are inviting the right people.
  • Don’t waste people’s time. If there isn’t a good reason for a meeting, don’t hold one.

Please add your own meeting tips and thoughts.

Share and Enjoy:
  • StumbleUpon
  • Technorati
  • del.icio.us
  • TwitThis
  • Google Bookmarks
  • Reddit
  • email
  • Digg
  • Facebook
  • MyShare

Related links

Comments

5 Responses to “How Technical Writers Gather Information: Attending / Holding Meetings”

  1. Ewan Kennedy on August 15th, 2008 2:54 am

    Your tips, which I think apply to most types of meetings, are absolutely spot on and I agree it’s often a good idea to hold your own meeting since there’s no better way to influence the process and the eventual outcomes.

  2. John Hewitt on August 15th, 2008 8:21 am

    @ Ewan

    Running my own meetings has made all the difference on my latest project.

  3. fourkstrong on August 15th, 2008 3:37 pm

    This article is a little ahead of where i’m at right now. I have B.A in creative writing and love poetry but recently trying to make the transition from creative writing to technical writing. I was wondering if anyone could help me speed this transition up a bit or know of a good place to start a technical writing career if you have a creative writing background

    fourkstrongs last blog post..What Makes A Good Relationship

  4. Lillie Ammann on August 15th, 2008 4:38 pm

    John,
    Every manager in every corporation should have read and follow these tips for meetings. There would be far fewer meetings that “meander from dull to sleep-inducing with an occasional stop at tense,”

  5. John Hewitt on August 16th, 2008 3:53 pm

    @ 4k

    I majored in Creative Writing in college as well, and I made it as a technical writer. I would recommend that you work on tool skills such as Robohelp and Framemaker, as well as developing your skills in a technical area (computers, science, law, medicine, chemistry, engineering, etc.).

    @ Lillie

    Over the past few weeks I have averaged two to three meetings a day. It can be a real grind, but at least half of them were worth my time.

Feel free to leave a comment...
and oh, if you want a pic to show with your comment, go get a gravatar!

Warning! Comments that do not meet the guidelines will be deleted.





CommentLuv Enabled
Bottom