Search results

Technical Writing – Making Resolutions for the New Year

by Tom Johnson on Dec 27, 2010
categories: technical-writing

Technical Writing Resolutions for 2011As 2011 approaches, Lynda at encourages technical writers to make technical writing resolutions for the new year:

A new year means you get the chance to do things over, to do things better. Whether you've been happy with your technical writing team or you think things should improve, it's time to look back on the past year to see what needs to improve and what needs to be removed from your company for the year ahead. (Technical Writing – Making Resolutions for the New Year)

A few of her recommendations were on the conservative side, in my opinion. Update your software, modernize your style guide. Nevertheless, this got me thinking about new directions I'll take in 2011. I've been moving in some of these directions for a while. Here are the top 10 technical writing resolutions I have for 2011.

  1. Use wikis rather than traditional HATS to author help content.
  2. Give users quick reference guides rather than long printed guides.
  3. Include more visuals, especially concept diagrams, in my help content.
  4. Master Adobe Illustrator and increase my understanding of visual techniques.
  5. Read more of my RSS feeds online and use them as a way to generate ideas for posts.
  6. Start negotiating with project managers using an official user education plan rather than informal agreements.
  7. Implement an official workflow of post-release documentation efforts based on user feedback, bugs, questions, and other unforeseen situations.
  8. Solidify our team with standard approaches and processes as well as build unity through proximity.
  9. Contribute to corporate blogging efforts for IT site.
  10. Interact with community through forum, feedback, and other participation channels; stay abreast of needs and questions.

These aren't so much resolutions as directions I'm heading.

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.