Developing the Specification for a Document

Between 25-30 percent of the overall writing time is typically devoted to developing the document specification, meaning how the document will be formatted and actually present the information. This is true even when the organization has a style guide with a prescribed format, but no “standard” for documentation overall. Although this may seem an inordinate amount of time and effort on the front end, before getting any information onto the paper, it is far more cost-effective than spending unplanned time rewriting and reformatting the document late in the production process.

Tech-Writer. Articles>Writing>Project Management>Technical Writing

Empathize with the Writer    

It is my firm belief that every technical writer is passionate about her work and would put in her best efforts to deliver high quality. If you are a manager or an editor and are shaking your head in disagreement, think again. Why would someone want to submit a work of poor quality?

Lawrence, Prema. International Journal for Technical Communication (2006). Articles>Writing>Project Management>Technical Writing

The Hidden Relationship Between Project Managers and Technical Writers  

Want to know the secret to better quality documentation and improved software design? Will Kelly outlines how the key is an effective relationship between project managers and technical writers.

Kelly, William T. TechRepublic (2003). Articles>Collaboration>Project Management>Technical Writing

Real Costs Of Technical Publications  

This workshop shows a technical publication manager or rising professional how to work in the following technical publishing/financial areas: project management, operating budget preparation and management, and quality control.

Caernarven-Smith, Patricia. STC Proceedings (1994). Articles>Publishing>Technical Writing>Project Management

Six Reasons You Don't Need a Technical Writer (and Why They're Dead Wrong!)

Hiring the right freelancer to do the job correctly the first time around could save you hundreds or thousands in help desk calls, service calls, document revision, and distribution. Here's why.

Zuccardy, Ann. Ezine Articles (2005). Articles>Project Management>Writing>Technical Writing

A Tale of Two Technical Writing Teams  

Sometimes considered an afterthought in the product development lifecycle, technical writers often struggle to become part of a performing Agile team.

Broderick, Stacia. Rally Software Development (2007). Articles>Project Management>Agile>Technical Writing

Using the Triage Method in Technical Writing

Pragmatism is the necessary first step: do the best job you can do under the conditions. Nobody's going to benefit if you do a superb job on half the manual, then die of stress before you can document the important parts in the second half.

Hart, Geoffrey J.S. Geoff-Hart.com (1999). Articles>Project Management>Writing>Technical Writing

Why Writing Deadlines May Be (Almost) As Good As Money

As much as we all like and/or need money, getting paid may not be enough to keep a writer motivated. Deadlines often are just as important. Although some of us fear — or even hate — them, the truth is that without them many of us simply wouldn’t write anything. And you can count me among those many.

Hewitt, John. Writer's Resource Center (2008). Articles>Writing>Technical Writing>Project Management

When Trust Becomes a Characteristic Flaw in a Project

As hard as it may seem, lesson one of technical writing is to break the rules and contact the end user. Conduct a mini-ethnography. Sit with the users. Call them on the phone. Send them emails. Do not let it get to the point where you feel you must go through the PM to communicate with the end user. As hard and uncomfortable as it may be, the consequences of not talking to the end user can be crippling to your help.

Johnson, Tom H. I'd Rather Be Writing (2008). Articles>Project Management>Collaboration>Technical Writing

What’s Wrong with PowerPoint as a Document Authoring Tool?

It is our position that use of PowerPoint for document planning negatively impacts all potential collaborative authoring and review outcomes. Though PowerPoint is commonly used because it is a familiar tool, it is not the most effective tool for managing knowledge either intellectually or financially.

Cuppan, Gregory P. Brainery.net (2009). Articles>Project Management>Technical Writing>Microsoft PowerPoint

Too Many Inputs Freak Out the Technical Writer

In such a scenario, this article presents some of the practices that have helped me track and address inputs effectively – regardless of their volume and importance.

Machani, Sridhar. Indus (2009). Articles>Project Management>Writing>Technical Writing

How Soon is Now?

One common complaint a lot of technical writers have is that they aren’t included early enough in lifecycle of a project. The downsides are that by the time work hits your desk you don’t have a full picture of who the customer is, why they want whatever it is you are building, and how they want it provided to them. All of which directly impacts the information being created.

McLean, Donna. One Man Writes (2009). Articles>Project Management>Technical Writing>Collaboration