Michael Lefevre wrote:
> 
> On 2004-01-17, fantasai <[EMAIL PROTECTED]> wrote:
> > Simon Paquet wrote:
> >>
> >> So, any suggestions for the document here?
> [snip]
> >> (for example bug description and/or summary are clearer,
> >> a patch is already attached, a lot of people are already
> >> CC'ed, etc.)
> >
> > You can take out the "for example" and the linking verbs
> > (is, are).
> 
> Heh... those weren't there in an earlier draft - they were inserted at my
> suggestion :)  You can't just put a list into the middle of a sentence,
> even if it is in brackets, IMHO.  But that's not important...

Maybe that's why I picked them out as not fitting. :)
That remark is not fitted into the paragraph. It still
feels like a list.

> > b) Don't use emphasis (<strong>) for codes.
> >    <code> is more appropriate.
> 
> Not all of these have been changed (e.g. talking about blocker and
> critical severity).
> 
> In any case, I think it makes the document hard to read.  Is it necessary
> to use <code> tags each time the document mentions "product" or
> "component"?  I'd be inclined to use <code> just for the values, and leave
> the field names as normal text.

I think the component field names should be distinguished from
regular text. But I'd use <var> instead of <code>.

> > c) Don't use capital letters for emphasis.
> >    Use <strong class="stronger">, if you need to.
> 
> I think there's a bit too much emphasis generally in this doc.  If you're
> emphasising words in several sentences next to each other, it might be
> best to work out which is the most important to emphasise, and drop the
> other emphasis.

Yeah, I agree. :)

~fantasai
_______________________________________________
mozilla-documentation mailing list
[EMAIL PROTECTED]
http://mail.mozilla.org/listinfo/mozilla-documentation

Reply via email to