FAQ: Tech Writing
Also check out FAQ: Jen
Can we hire you as a programmer?
You’ve heard about an infinite number of monkeys with an infinite number of typewriters eventually generating Hamlet? Well, I’m not that slow, but there are many more efficient programmers out there. You should probably hire them for your source code. But if you need an extra hand writing sample code or documenting existing code, then I’m your gal.
Why can’t our engineers just document their own work?
Some can. But they’d probably rather be writing code. And it’s surprisingly difficult to think like a user when you’re approaching something you’ve built yourself.
Nobody reads the manual anyhow. Why should we care about it?
Solid docs can reduce tech support calls and customer frustration. And sloppy documentation makes your product look bad.
Want to see a rewrite in action? Have a look at this example.