Date: Thu, 14 Jun 2001 01:31:21 -0500 From: "G. Adam Stanislav" <adam@whizkidtech.net> To: Chern Lee <chern@meow.osd.bsdi.com>, <freebsd-doc@freebsd.org> Subject: Re: Style/Grammar/Writing Guidelines Message-ID: <3.0.6.32.20010614013121.00eb5100@mail85.pair.com> In-Reply-To: <Pine.BSF.4.31.0106131439170.43965-100000@meow.osd.bsdi.com >
next in thread | previous in thread | raw e-mail | index | archive | help
At 14:53 13-06-2001 -0700, Chern Lee wrote: >Reference to the reader as "you" is informal. Changing this to "One" or >"The user" sounds very fitting to me. Ouch! No, please no! >Suggestions, please? Forget what you learned in high school and take a Writer's Digest course! :) Seriously, much of the technical literature is so formal because it is written by people with no formal training in being a good writer. I once read a fantastic article on non-fiction writing in Writer's Digest which took some section from the New Testament, and rewrote it using the style of so many technical writers. Hahaha, did it ever kill the message! A handbook is of no use if it puts you to sleep in the first paragraph. Grab their attention, make them feel you are a personal friend who is trying to help them, and, by golly, make sure they understand what you are trying to teach them. The best technical writing reads like a novel! Cheers, Adam --- http://phonecowboy.com/registrar/twist/ finds a good domain for you and checks for its existence. To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?3.0.6.32.20010614013121.00eb5100>