Learn from your topics and collaborate

We tech writers can learn from our chunks of content: What makes a topic successful can also make us writers successful! I had this idea while reading one of my favorite management blogs, Jurgen Appelo’s noop.nl.

In a recent post, Jurgen talks about what turns a bunch people into a team: It’s a shared purpose and a common identification as an entity. (Duh, so far… – But here comes…) This, Jurgen says, is also called “chunking”.

The chunking principle

“That’s like chunked topics in topic-based authoring,” I thought immediately and started to sort out more parallels:

  • A team is self-contained and has an identifiable purpose that distinguishes it from other team, just as each topic does. (Though we humans can belong to several teams consecutively or at the same time, so we can lead more interesting lives than our topics…)
  • Teams, such as tech writers, create context by connecting to other related teams, such as trainers, testers, interface designers, information architects, content strategists, etc., just as topics link to related topics.
  • “Teams don’t operate well when people don’t know what the teams are, and who they can rely on,” Jurgen says. Your collection of topics won’t play nicely, either, if it’s not clear what the other topics are and whether readers and writers can rely on them.

Jurgen goes on to emphasize boundary management of teams that helps to ensure that teams can work well and efficiently. If you’re at all interested in team management, check out his post – and his blog as a whole.

Collaborate like topics

I think there’s a lesson for tech writers here beyond team management: How successful you’ll be in your work as a tech writer depends on how well you define your job’s purpose and communicate it to others:

  • Be clear in what you need from product managers, from developers, from subject-matter experts and when and how you need it.
  • Be clear in what you can offer to training (content for training materials), to product management (fact checking and editing of brochures), to testing (written use cases).

In short: Do like your topics and collaborate! Given that we tech writers are communicators by trade, we shouldn’t find it too difficult to speak out on our own behalf. 🙂

Your turn

How important is it to your success that you collaborate efficiently with other teams? Do they understand what you do and how you work? Please leave a comment.

Advertisements

5 Responses

  1. “Do like your topics is a great idea”. I’d expand this idea a little more and remind us writers that developers work like their code. Their method of work is object-oriented: they encapsulate what they do and expect to get an encapsulated (that is finite and complete) chunks of documentation in return.

  2. […] This post was mentioned on Twitter by writerriver and Jason Hall. Jason Hall said: Reading: "Learn from your topics and collaborate…" Great web writing tips for #tech writers ( http://bit.ly/dk4e5w ) #BCIT1110 […]

  3. […] Tech Writing Blog Learn From Your Topics and Collaborate We tech writers can learn from our chunks of content: What makes a topic successful can also make […]

  4. What an interesting parallel…. I’ll have to consider ways I can do this. Thanks for posting!

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: