Does it take a community to document a technical issue?

The technical writer profession takes it on the chin sometimes. So much so, community-based technical documentation – user forums, wikis, blogs, and other social media – is becoming a go-to source for technical documentation and training. On how to perform technical tasks and thus to … “Does it take a community to document a technical issue?”

Read More

Simple guidelines for running technical document reviews remotely

With some clear expectations and a little planning upfront, running remote writing and document review projects can go smoothly.  Here are some lessons I learned when I was a freelancer about running remote writing and editing projects:

Read More

My Word template manifesto

For reasons that continue to elude me, I’ve come across a lot of Microsoft Word template issues in my time. Some templates were so bad that what should be a simple productivity tool ends up hobbling documentation efforts. Finding template issues is a never-ending source … “My Word template manifesto”

Read More

Lessons learned from working as a computer book industry technical reviewer

I was a computer book technical reviewer earlier in my career. It was a freelance gig, but I still consider the work one of the more formative chapters in my professional writing career even though it wasn’t writing work. Computer book technical reviewers sometimes called … “Lessons learned from working as a computer book industry technical reviewer”

Read More

The gentle art of project documentation control

Managing project documents can be an underappreciated art in some organizations. It’s an area where a technical writer should take charge. I’ve seen document control of all stripes throughout my career. Document control that works. Document control that didn’t work. Even document control that caused … “The gentle art of project documentation control”

Read More

4 reasons why your document reviews aren’t working

I’ve long been a student of technical document reviews. So much so, I worked as a technical reviewer for some computer book publishers to learn more about this critical element of the technical communications. Back then I thought I could do a better job than the … “4 reasons why your document reviews aren’t working”

Read More

5 ways teams can recover from a failed or stalled writing project

It’s never fun watching a technical documentation, training development, or other writing projects get off to a false start or just downright fail. It can be a real morale blow and expose the writer(s) and their team to criticism from stakeholders. However, failures do happen, … “5 ways teams can recover from a failed or stalled writing project”

Read More