From the category archives:

Content Development

Video as a need-it-now content delivery medium?

by techcommdood on June 4, 2010

Video Icon2
Image via Wikipedia

More and more I’m seeing references to videos for product walk-throughs and how-to information. While these are informative, I’m seeing a trend where as video is used more, context-appropriate traditional text-based information is in decline. When I have 30 minutes of down time, I enjoy watching these videos, but in the heat of getting something done I simply haven’t the time nor desire to break pace and watch a video. Why?

  • I can’t skim a video for relevancy.
  • Most video walk-throughs and procedures are lengthy, slow and seldom have a speed control, where a written procedure can be read at the speed of the reader.
  • In a procedure scenario, it’s more difficult to move step by step from video to application and back than it is with text (at least from my experience).

I do see promise with using video, though. It’s helpful to see someone performing an action to get a feel for how to do it yourself. I think the following guidelines might help in product info/how-to videos:

  • Each video should cover one and only one topic, unless the intent is an overview or other high-level topic.
  • Videos should be as short as possible .
  • Use specific keywords to index the video to ensure people find the right info.
  • Provide a text overview and/or procedure with the video. Let the video instruct and the text be a reference guide.
  • Never document in video what is not equally documented in text. Ever.
  • All videos should be accessible from a central area via topic groupings, index, and smartly-tagged keyword search.

Thoughts?

Reblog this post [with Zemanta]

{ 5 comments }

Using Conditional Text in Adobe Technical Communication Suite 2

June 3, 2010 Content Development

Image via Wikipedia

If you’ve been following me on Twitter, you’ve likely seen my frustration in trying to get conditional text to work in a linked file scenario with FrameMaker 9 and RoboHelp 8. I’m writing this post to help others who may be struggling with this issue, and to alert Adobe to a need for [...]

15 comments Read the full article →

Are social media and online collaboration tools intimidating to the technical communicator?

February 10, 2010 Content Development

Lately I’ve been hearing from quite a few technical communicators (technical writers, editors, illustrators, etc.) that they are either intimidated by or otherwise uninterested in social media tools and online collaboration tools. Rather than use a dynamic scratch pad like Wave to brainstorm they’d prefer a phone conference. Rather than use threaded forums they’d prefer [...]

4 comments Read the full article →

Thoughts on FrameMaker

March 3, 2009 Content Development

I was writing a comment on techcommtoolbox.com about FrameMaker and realized not only was it getting quite lengthy, but it would be good info to share here. I know FramMaker isn’t for everyone, but it really is a robust and flexible application when it comes to authoring technical content.
And for those who don’t know, you [...]

1 comment Read the full article →

When to Single-Source

February 19, 2009 Content Development

The following originally appeared in the June 2002 issue of the STC Single-Sourcing SIG newsletter. I’m repurposing it here in the event that the SIG site redesign purges the content. Although an older article, much of it still applies today.
When to Use Single-Sourcing
It depends.
Don’t you just love that answer? I know I do. I love [...]

0 comments Read the full article →

Topic-Based Authoring: Of DITA and Chocolate and Other Fine Food

February 16, 2009 Content Development

I’m seeing more and more about DITA, and particularly topic-based authoring. I’m having trouble wrapping my head around topic-based authoring being a new concept. I can remember learning about it in my first semester of communications studies. With the advent of DITA, have the fundamental concepts around topic-based authoring changed? I’d like to think not.
I [...]

2 comments Read the full article →

Implementing Structured Authoring Survey

February 12, 2009 Content Development

Scriptorium Publishing Services is still soliciting survey responses for their Implementing Structured Authoring survey. A results summary report will be made available for free to all respondents, otherwise the report will run you $200. Take the survey, help shape the results, and sign up for your free copy of the report today. The survey closes [...]

0 comments Read the full article →