Archive for the "via Feed" Category

Podcast: How do design, length, and relevance affect how people use API reference docs — interview with Bob Watson

Listen to the podcast

You can download the MP3 file here.

Summary

Bob was a software engineer for 17+ years. He decided to get a PhD from the University of Washington’s Human Centered Design and Engineering because he felt that if the documentation for his software were better, the adoption of the software would increase. (Read more...)

An easy way to support my site: Sign up for technical writing job alerts

I’ve added a Zip Recruiter feature on my site. You can now search for jobs by clicking the Jobs button on the top navigation bar. Additionally, you can sign up for job alerts by filling out the form at the bottom of each post.

Here’s what’s cool about this feature. Not only are the jobs (Read more...)

How do you test content that’s beyond your skill level?

  1. 1.0 The key to writing good documentation: Testing your instructions
  2. 1.1 Should QA test documentation?
  3. 1.2 Communicating feedback from testing documentation
  4. 1.3 Should technical writers care about more than documentation?
  5. 1.4 Should you add your testing scenarios into your documentation?
  6. 1.5 → How do you test content that’s beyond your skill level?

This (Read more...)

LearningDITA.com: A new online learning resource for DITA by Scriptorium

A Free Course on DITA

One common question I receive from people on this site is how they can learn DITA. Scriptorium has published a new online course (their first, I think) called LearningDITA.com. The first course available is “Introduction to DITA.”

Learningdita.com is a free online resource created by Scriptorium for learning DITA

(Read more...)

Should you add your testing scenarios into your documentation?

  1. 1.0 The key to writing good documentation: Testing your instructions
  2. 1.1 Should QA test documentation?
  3. 1.2 Communicating feedback from testing documentation
  4. 1.3 Should technical writers care about more than documentation?
  5. 1.5 → Should you add your testing scenarios into your documentation?

This is another post in my series on testing documentation.

What (Read more...)

Other Stuff