Avoiding Mission Impossible technical writing projects

Photo by Aaron Mello on Unsplash I’ve had the great fortune in my career to work on some very tough projects — in what I like to call documentation unfriendly environments — and won some and lost others but learned so much about technology and how to work independently as … “Avoiding Mission Impossible technical writing projects”

Read More

Building the better technical editing and QA cycle

Photo by Avi Richards on Unsplash It’s rare when I don’t hear complaints about the technical editing and reviewing of documents and the QA cycle in general. It’s unfortunate because building a document QA process that’s supportable and replicable Here are some considerations to keep in … “Building the better technical editing and QA cycle”

Read More

5 reasons why your enterprise social network won’t improve your document reviews

Photo by Lauren Mancke on Unsplash Through my work as a technical writer, I’ve become a student of document reviews especially those performed by geographically dispersed work teams. You may know from your own experience that document reviews can be a painful process — often times poorly enforced, … “5 reasons why your enterprise social network won’t improve your document reviews”

Read More

Using Trello for managing editorial projects

My work as a technical writer sometimes means having to manage my own projects yet communicate about them in a way that programmers and engineers can understand without having flashbacks to college freshman English. I’ve come to use Trello for managing document projects. Technical people … “Using Trello for managing editorial projects”

Read More

3 Microsoft Word template decisions to avoid

Microsoft Word templates can be an incredible productivity tool. Templates ensure a consistent look and feel across your documents. Using a template frees you up to focus on other things about the document you are writing. Yet, Microsoft Word templates can also be a productivity … “3 Microsoft Word template decisions to avoid”

Read More

Things they don’t teach in technical writer school

Photo by Feliphe Schiarolli on Unsplash I got my start as a technical writer before any formal technical writing degree programs got their start. While college gave me a solid foundation, much of what I know today, I learned by actually doing the work. Regardless of … “Things they don’t teach in technical writer school”

Read More

3 things technical writers can learn from screenwriters

Photo by rawpixel.com on Unsplash A few years back I took a screenwriting course through Georgetown University School of Continuing Studies. It was a challenging course. The professor had a bit of an ego so I didn’t get as much out of it as I had … “3 things technical writers can learn from screenwriters”

Read More

Do organizations need technical documentation style guides?

Photo by Oliver Thomas Klein on Unsplash Do organizations need technical documentation style guides? It’s a question that rises on online forums every so often. Today’s ever-tightening workplace budgets should also put the role of the technical documentation style guide under the spotlight. My answer to … “Do organizations need technical documentation style guides?”

Read More

Is “3” the answer to many of your document problems?

Photo by Tobias van Schneider on Unsplash I’ve spent the better part of my professional career as a contract technical writer. During that time I got the chance to examine why some organizations struggle with their technical documentation. With limited resources and budget, it is sometimes … “Is “3” the answer to many of your document problems?”

Read More