Style guidelines (was Short-n-sweet)

Matthew East mdke at ubuntu.com
Wed Oct 24 08:54:24 UTC 2007


Hi,

On 24/10/2007, Matthew Paul Thomas <mpt at myrealbox.com> wrote:
> First, avoid describing instructions as "simple", or telling people to
> "simply" or "just" do something. For people who are comfortable
> following the instructions, those words won't make them feel any
> better. And for people who *aren't* comfortable following the
> instructions, it's irritating. <http://urlx.org/google.com/41e77>
>
> ("Simply" is in the "Words to avoid" list I suggested last year.
> <https://lists.ubuntu.com/archives/ubuntu-doc/2006-July/006669.html>
> Perhaps I should put this list on the wiki?)

They should go in our styleguide. In turn, I think it would be
advantageous to move the styleguide from our svn and doc.ubuntu.com to
our namespace in the wiki. This would enable it to be updated more
easily, and to be easier to find.

Any objections?

>     = Frobnicating the wizzle =
>
>     If the wizzle is lolloping gangrously, you may need to
>     frobnicate it.

Haha.

-- 
Matthew East
http://www.mdke.org
gnupg pub 1024D/0E6B06FF




More information about the ubuntu-doc mailing list