see http://bugzilla.mozilla.org/show_bug.cgi?id=53153
For consistancy with (English) documentation, I think we need a style guide to
word choices and grammar. Below is just a short list of words that we should
watch out for. Feel free to add more entries. Also feel free to disagree with
me.
e-mail and email: n. electronic mail
Both variants are commonly accepted. The general public seems drop the hyphen
while editors (and probably English professors) seems to favor "e-mail". (I favor
"e-mail" because it retains the original meaning and because it's more readable.)
However, since "email" is used in mozilla more than "e-mail" is, the hyphen-ized
form should be used.
Usage: the "e" in e-mail (or email) should not be capitalized unless it is the
first word in a sentence. (Even though Email is more readable than email)
Usage: (please prove me wrong if I am) e-mail (or email) is a noun, not a verb.
So "please e-mail us" is incorrect and should be "please send us a e-mail".
wrong and incorrect:
usage: had to point this out because I just made this mistake (had '"please e-mail
us" is wrong'). Use "incorrect," "improper," "insufficient," etc.
log-in: noun e.g. "log-in is complete"
log in: verb e.g. "please log in"
Since "log in" is not a commonly used word (a person who knows little about
computer usually knows "e-mail" but doesn't know "log in"), the hyphen should
be retained.
log-off: noun
log off: verb
add-on: <-- just what the hack this is?
alert: all developers in www.mozdev.org
plug-in: <-- and this?
e.g. if Sherlock is a plug-in, what are the search engine things we add to
the Search sidebar?
Again, hyphen should be retained
helper application:
needs definition
performance
use with caution. see http://bugzilla.mozilla.org/show_bug.cgi?id=126600
while we are on the subject of "performance", here is a list of some defintions from
ISO 9000:2000 (slightly edited)
efficiency
relationship between the result achieved and the resources used
effectiveness
extent to which planned activities are realized and planned results achived
quality:
degree to which a set of inherent characteristics fulfils *requirements*
(/implied, stated, or oblgatory needs or expectation/)
quality assurance (QA):
part of quality management, focused on providing confidence that quality
requirements will be fulfilled
note: QA does not guarantee that quality will be achived, that's quality
control (QC)
document
*information* (/meaningful data/) and its supporting medium
specification
*document* stating *requirements*
verification
confirmation, the the provision of objective evidence, that specified
*requirements* have been fulfilled
validation
confirmation, the the provision of objective evidence, that the
*requirements* for a specific intended use or application have been
fulfilled
e.g. "verify the code against the specification"
e.g. "validate the code against the intended use"
shall, must, may, etc.
see http://www.ietf.org/rfc/rfc2119.txt
standard
see http://hebb.cis.uoguelph.ca/~dave/343/Lectures/standards.html
mozilla
a W3C standard-compliant browser?
or just another browser (what's up with document.all and marquee)?
or something that every other browser should have been?
lizard
what mozilla is - looks scary, but in fact is friendly :)
