: Re: Can technical writing suck less I currently have the prospect of writing a considerable amount of technical documentation (describing interactions with an extremely complex online service). I consider

I would say first to take your ego out of the equation. Technical documentation serves a specific purpose, which is to impart information from an authoritative source to a reader. Superfluous information, such as humor, is a distraction.

Say I want to connect my DVD player to my new flat-screen TV. I don't want to hear about how your grandfather poo-pooed color when RCA introduced it. How does that help me complete the task? Here are the criteria for technical docs, in order of importance:

Is it accurate?
Is it complete?
Is it appropriate?

Stick to the task and the facts. If you are new to the game, find a good editor, hopefully one who is conversant in the field, and pay attention to their comments.

Load Full (0)

: Is it foolish to pursue a writing career while desiring complete anonymity? I am writing my first novel. When I finish, I'd like to try publishing it. I've read other questions regarding the

@Deb2945533

Load Full 5 Comments

: How to give written advice in a way that is encouraging, not overbearing How do we write something to inspire a person which corrects the mistakes they've made until now, but without making

@Deb2945533

Load Full 3 Comments

: A better word for dusty? I am describing the condition of cardboard boxes which have been in the attic for years. They are in good condition and aren't dirty. The sentence is "dark and...?"

@Deb2945533

Load Full 2 Comments

: Agents and publishers get so many manuscripts that they have to screen them quickly. Anything, especially in those first few pages, that makes you seem no better than average will get you

: Re: Can technical writing suck less I currently have the prospect of writing a considerable amount of technical documentation (describing interactions with an extremely complex online service). I consider

More posts by @Deb2945533

: Is it foolish to pursue a writing career while desiring complete anonymity? I am writing my first novel. When I finish, I'd like to try publishing it. I've read other questions regarding the

: How to give written advice in a way that is encouraging, not overbearing How do we write something to inspire a person which corrects the mistakes they've made until now, but without making

: A better word for dusty? I am describing the condition of cardboard boxes which have been in the attic for years. They are in good condition and aren't dirty. The sentence is "dark and...?"

: Agents and publishers get so many manuscripts that they have to screen them quickly. Anything, especially in those first few pages, that makes you seem no better than average will get you

Login to post a comment!

0 Comments

Back to top