Category: Technical Writing
You know "cheap, fast, or good"?
January 18th, 2010How about one out of three? This is from an installation guide that I inherited:
An upgrade installation is initiated by specifying an installation directory that is at the same directory level as the installation directory that was specified for… more »
What's my line?
January 20th, 2009For 13 1/2 years now, I've been employed as a technical writer. By half a dozen companies (and one consulting job), and writing damn near every type of software doc possible. But in my current position, "technical writer" doesn't cover my role or respon… more »
A helpful suggestion
September 10th, 2008This is a stupid thing, but it's something that always comes back to bite me in the ass: Whenever you create an illustration/graphic that uses text, record the font and size that you used. Otherwise, you'll have to waste a huge amount of time trying to… more »
Discussing and defending heading styles
March 24th, 2008I'm a technical writer. When I write technical documentation, I follow strict rules about capitalizing words in headings. My companions on this site are following those rules. I started to (see my first post), but then I decided to go with an informal s… more »