Printed manuals should be brief
Technical Writing

Principles for Organizing Print Material [Organizing Content #21]

For years I prided myself on single-sourcing both online help and printed guides. When I used...

Content versus Findability
Blog,Technical Writing

Relying on the Wisdom of the Crowds with Help Authoring [Organizing Content #20]

The most compelling idea from emergence, which I explained in my previous post, is the surprising...

crowd
Technical Writing

Emergence [Organizing Content #19]

In the ongoing series on organizing content, we now shift attention to the phenomenon of emergence,...

spotcarriesskippy
Blog,Creativity,story

Replaceability

About a month ago, I was talking with some of my friends at church when my wife Jane came into the...

Problem Solving and Sprinkler Repair
Creativity

Problem Solving and Sprinkler Repair

The other day Jane called and said I should come home because water was bubbling up in the...

Free Copy of Camtasia Studio 7 and Snagit 10
Screencasting

Free Copy of Camtasia Studio 7 and Snagit 10

Techsmith gave me a free copy of Camtasia Studio 7 and Snagit 10 to give away on my blog. To enter...

Separating Basic from Advanced Topics: How Twitter Organizes Their Help [Organizing Content #18]
Technical Writing

Separating Basic from Advanced Topics: How Twitter Organizes Their Help [Organizing Content #18]

When you click Twitter’s help link, the help content is divided into three categories:...

Latest Blog Posts

  • Principles for Organizing Print Material [Organizing Content #21]
    This entry is part 21 of 21 in the series Organizing Content

    For years I prided myself on single-sourcing both online help and printed guides. When I used RoboHelp, I created custom macros in Word to clean up and adjust the print formatting. With Madcap Flare, I hammered out the print styles until everything looked clean. And then I made a major mistake: I more or less  Read more »

    Posted on 30th Jul 2010 17 comments
  • Relying on the Wisdom of the Crowds with Help Authoring [Organizing Content #20]
    This entry is part 20 of 21 in the series Organizing Content

    The most compelling idea from emergence, which I explained in my previous post, is the surprising wisdom of the crowd. The guesses of 800 people about the weight of an ox at the county fair averaged out to be just one pound from the actual ox’s weight. The wisdom-of-the-crowds idea is revolutionary. Traditionally “the masses”  Read more »

    Posted on 27th Jul 2010 8 comments
  • Emergence [Organizing Content #19]
    This entry is part 19 of 21 in the series Organizing Content

    In the ongoing series on organizing content, we now shift attention to the phenomenon of emergence, and how intelligent, sophisticated systems emerge from relatively simple, unsophisticated parts. I listened to a Radiolab podcast the other day that explored this topic in depth. The hosts related how in the 1800s, Francis Galton visited a county fair  Read more »

    Posted on 20th Jul 2010 8 comments
  • Replaceability

    About a month ago, I was talking with some of my friends at church when my wife Jane came into the room crying and asking where Kevin was. I wasn’t sure what happened, but I soon found out. Jane had been substituting in Primary, a class for children. During a game where everyone gets to  Read more »

    Posted on 19th Jul 2010 8 comments
  • Problem Solving and Sprinkler Repair

    The other day Jane called and said I should come home because water was bubbling up in the sprinkler box in the yard. I don’t know anything about sprinkler systems, so with a sense of dread I drove home. Sure enough, the valve box was a puddle of water. I do know how to shut  Read more »

    Posted on 15th Jul 2010 4 comments
  • Free Copy of Camtasia Studio 7 and Snagit 10

    Techsmith gave me a free copy of Camtasia Studio 7 and Snagit 10 to give away on my blog. To enter the contest, just leave a comment on this post. In your comment, tell me something interesting about screencasting. It could be a tip, an argument, a story, a scenario, a technique, or whatever. The  Read more »

    Posted on 12th Jul 2010 23 comments
  • Separating Basic from Advanced Topics: How Twitter Organizes Their Help [Organizing Content #18]
    This entry is part 18 of 21 in the series Organizing Content

    When you click Twitter’s help link, the help content is divided into three categories: Twitter Basics Something’s Not Working Report a Violation This division suggests a mental pattern about how people use help. You have the newbie group. These people are new to Twitter and need a grounding in the basics, such as what an  Read more »

    Posted on 8th Jul 2010 2 comments
  • Do Some Project Managers Suffer from the Dunning-Kruger Effect?

    Errol Morris has a lengthy essay in The New York Times on something known as the Dunning-Kruger Effect. Essentially the effect is that even though something is obviously wrong, a person is incapable of recognizing it. Cornell profesor David Dunning stumbled onto the idea when he read about a bank robber who squirted lemon juice  Read more »

    Posted on 7th Jul 2010 7 comments
  • Does a Technical Writer Need to Understand Web Design?

    A reader asks, Technical writing is a field that I’ve been pursuing and about to complete a certification. My question, how important or valuable would also pursuing a web design certificate for a technical writer? The certificate in web design? Not necessary. But a working knowledge of HTML and CSS? Yes, critical, because everything is  Read more »

    Posted on 6th Jul 2010 3 comments
  • Breaking Things as a Form of Creativity

    IT Author’s latest podcast, Testing testing 123, dives into testing. Rather than just commenting on testing from a technical writer’s point of view, Alistair Christie and his co-host Graham Campbell interviewed an actual tester. It’s a good interview with lots of informational nuggets. For example, “regression testing” is testing those software features that were tested  Read more »

    Posted on 1st Jul 2010 1 comment

Sponsors

Scriptorium
MindTouch 2010 is the leading application the authoring, discovery and curation of strategic content
Dr. Explain
Lavacon Conference
Docutools
Madcap Software
Adobe
Snagit

WordPress Newsletter

  • WordPress Tip: Integrate Constant Contact with WordPress

    Today’s WordPress tip is on integrating Constant Contact (an email marketing service) with WordPress.

    Posted on 27th Jul 2010 0 comments
  • Add WordPress 3.0 Navigation System to Your Site

    Before WordPress 3.0, one of the frustrations with WordPress was configuring the navigation menu when you wanted to combine pages, categories, and URLs. The new navigation system in WordPress 3.0 solves this problem, because it allows you to create a menu by dragging and dropping almost any type of link. But just upgrading WordPress to  Read more »

    Posted on 12th Jul 2010 1 comment
  • WordPress Tip: There’s a Plugin for That

    I sent out this tip in my last WordPress newsletter. You can subscribe to my WordPress newsletter here. One of the many advantages of WordPress over other blog platforms is the number of plugins available. Plugins are scripts that you can add to WordPress to increase the functionality in some way. For example, a contact  Read more »

    Posted on 30th May 2010 2 comments
  • WordPress Tip: Backing Up Your Database

    I sent out this tip in my last WordPress newsletter. You can subscribe to my WordPress newsletter here. With WordPress 3.0 just around the corner, scheduled to be released before the end of the month, what should you do to prepare? When the update is available, you’ll see a notification message at the top of  Read more »

    Posted on 24th May 2010 1 comment
  • WordPress Tip: Creating WordPress Themes to Match Existing Sites

    I sent out this tip in my last WordPress newsletter. You can subscribe to my WordPress newsletter here. I decided to start up a WordPress newsletter to offer weekly tips on WordPress. I added the sign-up widget on my sidebar about a month ago. Since then, 56 people have signed up. I just sent out  Read more »

    Posted on 15th May 2010 0 comments

Recent Comments

  • SEO en Panama: It is nice to definitely find a blog where the blogger is well-informed. Thanks for creating your... (4)
  • Carolynn Poggio: Manuel Arquero (7)
  • dual boxing: Great article and point of view, but I wish it was a bit more technical in nature. (20)
  • fap turbo: enjoyed reading this blog and am bookmarking and sharing this with my social community on Digg (4)
  • diy putting a fence in: Usually I do not post on blogs, but I would like to say that this article really forced... (3)
  • Larry Kunz: Tom, I think — check that, I know — that I’m biased in favor of indexes. So I have... (17)
  • Ben M: This discussion illustrates to me why you need professional tech communicators working on this stuff. The... (17)
  • Karen Mulholland: Great insight about leaning toward the conceptual in the print version and tasks in the help... (17)
  • Anoo Shaker: Thanks for a great post, Tom! I agree that short printed matter like “Getting Started... (17)
  • Paul K. Sholar: Think about writing documentation for power plant-control software. The screen is dedicated to... (17)

Breaking into Technical Writing

Are you a student looking to break into technical writing? Or are you a professional trying to transition into technical writing? This list of posts on breaking into technical writing may be relevant to you.