Writer Angst

[mythteller]

Dear Programmer,

When I ask you to provide a definition for a component in the application, don't tell me that I don't need that information. I'm the writer, so I know what I need to include in my documentation. You're a coding monkey, so stick to what you're good at.

Please don't provide information that tells me how stupid you think I am. If I need a definition for an object call LargeRedBall, I need something a bit more substantial than a definition like "LargeRedBall is a large ball object of type red." That's not helpful. I need to know what it is using terms that are not used in the name of the thing and I need an example of its use.

Also, don't sigh and act like you're doing me a huge favour giving me this information. I'm not a technical writer because I'm too stupid to be a programmer.

Sincerely yours,

Hobbes
The Brittle Technical Writer

Comments

[sorceror.livejournal.com]

Of course, you post this just as I'm gearing up to bite the bullet and look for another tech writing job myself.

Thanks. I think. >_<

[grinningcoyote.livejournal.com]

Coding monkey? *cries*

Some of us are nice people too, y'know? :p

[tocityguy.livejournal.com]

Just a wee bit annoyed?

[jdhobbes.livejournal.com]

Does it show?