Words to avoid?

[Mike MacCana]

Thanks heaps Matt,

On 7/5/06, Matthew Paul Thomas <mpt at myrealbox.com> wrote:
> On Jul 4, 2006, at 3:18 PM, Mike MacCana wrote:
> > ...
> > * Word to avoid: System.
> > ...
> > * Better word to use instead:
> > - Computer
>
> Good.
>
> > - Kernel
>
> Not so good -- most people don't know what a kernel is. Use it if you
> absolutely have to discuss the kernel itself, otherwise just use
> "Ubuntu" (or equivalent depending on what derivative you're writing
> for).

Agreed 100%. Will add. Only mentioned 'kernel' above because some people
(and some programs, eg top) use 'system' as a synonym of 'kernel'. Obviosly
someone using the term kernel would be limited to times where hey actually,
specifically mean kernel.

Ubuntu / Kubuntu / Xubuntu stuff is good too. Will add.

> > * Word to Avoid: Architecture
> > * Why: Ambiguous.Is my architecture 'x86 64', or 'thin client'? The
> > front page of Community Docs has used the terms with both meanings for
> > a couple of months now. Most humans aren't aware that computers have
> > architecture.
> > * Better word to use instead:
> > - CPU type
>
> Similarly here, I think most people haven't heard of a CPU. And "Intel
> Core Duo" CPU type, for example, doesn't tell you whether it's a PC or
> a Mac. Perhaps "computer type".

This is a hard one. Computer Type is still ambiguous.

But imagine the current SupportArchitectures page replaced by something like
this...

There are three different versions of Ubuntu for different computer types,
depending on the CPU used in the computer.

(Instructions on how to check CPU type from Windows)
(Instructions on how to check CPU type from OS X)
(actually, screw that, lets determine if from their BrowserID!)

Intel x86
Most home an office computers are Intel x86. If you're currently running
Windows, and aren't sure what kind of computer you have, this is a safe bet.
If you have a recently purchased Mac, and it has an Intel processor, then
this is also the version of Ubuntu for you.

AMD64
The next popular type of computer is AMD64.

PowerPC
Most PowerPC are older Mac machines. If your system can run Mac OS X, and it
doesn't mention an Intel processor, then you have a PowerPC.

(then more info)

Just food for thought.

> > * Word to avoid: Configure, configuration
> > * Why: Unnecessary - 'configure' means the same thing as 'set up', but
> > isn't used part of regular, plain speech.
> > * Better words to use instead:
> > - set up, setting up
>
> Or "change", depending on the situation.

Cool, will add.


> > Any more suggestions/additions folks?
> > ...
>
> For anything produced or overseen by the Documentation Team, I
> recommend avoiding these words (and their plurals, participles etc):
> abort

Yup. Replace with Cancel, stop.

> allow...to

Replace with: Let.

> boot
  (replace initialize too)
Start

> browse

View

>, button, checkbox,
> conventions
>, dialog,
> dialogue
> radiobutton


Suggestions?

> die

Stop finish, end.

> documentation

help, instructions

> empower

Allows you to

> enable

Turn on

> following

Then, the next, etc.

> illegal

Sggestions?

> in order to

God I hate that one too. What a waste of words :^)
'to'

> kill

End process.

> note

Suggestions?

> please
> simply

Replace with nothing.

> tab

Actually think many people might know what tabs are, now Firefox is around.
What do you think would be better?

> this section,

This step.

> tick, usage, user, wizard.

Suggestions needed here too.

> In addition, for help intended to be read on-screen, I recommend
> avoiding:

> alternatively

Instead?

> consult

Read / look at.

> first

Replace with nothing.

> GNOME
> GNU, KDE
> guide, menu,
> next, welcome.

Unsure what you're suggesting we replace these ones with.

Thanks,

Mike
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20060706/55a1a99d/attachment.html>