Monthly Archives: March 2009

A Collaborative Writing Model for the Social Web

This post explores the activities and social media tools that technical communicators can use at each stage of the product development life cycle to collaborate with members of the user community, while developing audience-centered content for the social web. The stages used as a writing framework are “awareness, attention, engagement, execution, and extension” (as described in Chris Brogan’s post: Pirate Moves-From Awareness to Extended Action.) The five stages that apply to almost all software usage are also referred to as a model: unaware, interested, first-time use, regular use, and passionate use” (see Joshua Porter’s Designing for the Social Web: The Usage Lifecycle). Continue reading

Posted in Social Media (ROI, Tips, Tools, Trends), TechCom: Collaboration, TechCom: Process, Technical Communication | Tagged , , , , , , , , , , , , , , | 2 Comments

How to Deploy Social Media ~ a Call to Arms

In his post “While Others Paint the Trim,” social media evangelist Chris Brogan sounds a call to arms, challenging all social media enthusiasts and practitioners to supply specifics on how to implement and inter-connect social media tools, especially in larger organizations. He … Continue reading

Posted in Social Media (ROI, Tips, Tools, Trends) | Tagged , , , , , , | Leave a comment

Social Media Technical Communication: Developing Audience-Centered Content

Based on Rich Maggiani’s article in the Society for Technical Communication’s Intercom issue (May 2009), this post describes how social media is transforming technical communication, by providing “content for collaboration, not just consumption.” Maggiano encourages technical communicators to start using social media tools to moderate these types of customer interactions: blogs, forums, wikis, and mini social networks. Continue reading

Posted in Social Media (ROI, Tips, Tools, Trends), TechCom: Trends, Technical Communication | Tagged , , , , , , , , , , , , | Leave a comment

Analyzing Audience Without Direct Access to Customers

Provides tips on how to analyze audience for user assistance, without direct access to customers. Asks how the advent of Web 2.0, related social media tools, and user-generated content, can help technical communicators have more direct contact, and beyond that, collaboration, with our primary and secondary audiences. Continue reading

Posted in TechCom: Process, Technical Communication | Tagged , , , , , , , | Leave a comment

Understanding Audience and Purpose

This post describes primary and secondary audiences for technical documentation. It also provides criteria from the Society for Technical Communication and points to other resources to help you begin analyzing your audience and their respective purposes for using the documentation. Continue reading

Posted in TechCom: Process, Technical Communication | Tagged , , , , , | Leave a comment

Asking the Right Questions Adds Value

  The technical information for a product that is still in development does not often “live” in any one person’s head. It’s my job as a technical writer (or technical communicator, the title many of us prefer) to scout out … Continue reading

Posted in TechCom: Process, Technical Communication | Tagged , , , | Leave a comment

How Do You Build Successful Relationships with Your SMEs?

Getting a steady stream of good information from your SMEs (Subject Matter Experts) is not a given. It’s something that occurs over a period of time and is based on a work relationship, built on the same ingredients as any other successful … Continue reading

Posted in TechCom: Collaboration, Technical Communication | Tagged , , , , | Leave a comment

How Do You Get Information? Part Two: New Releases

Gathering information for a new product’s documentation requires even greater resourcefulness, research, and communication skills, than gathering information for a maintenance release. The challenge with a first release, is not only is there no existing UI to help you understand the functionality, but there … Continue reading

Posted in TechCom: Process, Technical Communication | Tagged , , , | Leave a comment

How Do You Get Information? Part One: Maintenance Releases

      As long as I have been writing technical documentation, the most common question interviewers ask me is how do I go about getting information for my documentation deliverables. For me, there really isn’t one answer or method for obtaining information. … Continue reading

Posted in TechCom: Process, Technical Communication | Tagged , , , | Leave a comment