Adobe Robohelp

Get new posts delivered straight to your inbox.

Subscriber count: 4,039

Stitcher radio

follow us in feedly

Want more tech comm blogs to follow? See my Tech Comm Collection of Blogs on Feedly.

Adobe FrameMaker

10 Quick Tips for Project Managers about Help Content

Nov 11, 2010 • general

10 Tips for Help Content
10 tips for PMs about help content

As a follow-up to my last post, When Help Content Is Forgotten, my colleague pointed out that having a set of agreed-upon best practices for technical writers is one of the first steps in establishing traction with project managers. Otherwise, project managers can resist or dismiss a technical writer's recommendations as subjective opinion.

In an effort to be concise, here's my stab at the ten things project managers should know when working with technical writers. Imagine formatting these ten sentences in a neat little card that you periodically email to project managers, or that you give project managers when meeting them for the first time. I made them concise so that they'll be read. These are the 10 concepts that all project managers should know about help content.

10 Best Practices for Help Content

  1. Allocate budget for help content in your project plan.
  2. After your project is approved, contact a technical writer about deadlines for deliverables.
  3. Recognize that what seems intuitive to you may be unintuitive to users.
  4. Technical writers need access to test environments, prototypes, and dummy data.
  5. The user interface is driven by text, so involve a technical writer's language expertise with prototypes.
  6. Because help content is part of the user experience, technical writers work closely with interaction designers.
  7. Expect short guides and visual content rather than long manuals.
  8. If collaboration and distributed ownership are important, consider a wiki platform.
  9. Technical writers are your application's first users -- their feedback can improve usability.
  10. Documentation isn't finished with the application's release, but continues as users submit feedback.

follow us in feedly

Get new posts delivered straight to your inbox.

Subscriber count: 4,039

About Tom Johnson

Tom Johnson

I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include technical writing, authoring and publishing tools, API documentation, tech comm trends, visual communication, technical writing career advice, information architecture and findability, developer documentation, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here.