diff --git a/LDP/howto/docbook/LDP-Reviewer-HOWTO.xml b/LDP/howto/docbook/LDP-Reviewer-HOWTO.xml index f6a555d6..09d84b31 100644 --- a/LDP/howto/docbook/LDP-Reviewer-HOWTO.xml +++ b/LDP/howto/docbook/LDP-Reviewer-HOWTO.xml @@ -275,8 +275,8 @@ and make any necessary changes. If changes are A summary of revisions should be included in the document. For more information about their markup, please read the notes in the Author Guide's Markup for Metadata. The initial release of a document should be marked up as Version 1.0. Subsequent updates should increment the version number appropriately. The preferred format is Major.Minor.Bugfix, where each section is an integer. - Some authors use Alan Cox style versions (e.g., 1.4pre-3) and some include - additional information (e.g., 1.3beta). This is acceptable but not encouraged. + Some authors use Alan Cox style versions (for example 1.4pre-3) and some include + additional information (for example 1.3beta). This is acceptable but not encouraged. The most important thing is that we have a version number so we know which version we are dealing with! Once a document goes through review it should advance in minor or bugfix version number, depending on the amount of change introduced. @@ -325,7 +325,7 @@ and make any necessary changes. If changes are Spelling Spelling should conform to a standardized English spelling of terms. For words that are new - to the language and not yet standardized (e.g. technical Linux terminology that is generally accepted + to the language and not yet standardized (for example technical Linux terminology that is generally accepted in the community), follow the most common spelling for the term. @@ -351,11 +351,14 @@ and make any necessary changes. If changes are tone of the LDP documentation. - Capitalization - The word HOWTO should always be in full caps with no hyphen. - Also, the document title should always be in title case. This means that first words in a title are always capitalized. - The only words not capitalized in a title are prepositions, articles, and proper nouns which would not be capitalized otherwise (e.g. - insmod). Other capitalization should follow rules of standard English. + Use of capital letters + The word HOWTO should always be in full caps with no hyphen. + The document's title and section headings may follow one of two + conventions, but must be consistent throughout. Titles may either + capitalize only the first word, or may capitalize each word. In the + second case the only words not capitalized in a title are prepositions, articles, + and proper nouns which would not be capitalized otherwise (for + example: insmod). Other capitalization should follow rules of standard English. Clarity @@ -429,6 +432,12 @@ and make any necessary changes. If changes are the document may not come to English as a primary language and, therefore, you should do your best to make sure that the document is as easy to understand as possible. + + Latin abbreviations + Avoid using abbreviations. e.g. (for example), et al. (and + others), etc (and so on) and i.e. (that is) should + always use the English equivalent. +