[jboss-as7-dev] Documentation headers

[Carlo de Wolf]

I used the same style as the JSRs.

e.g. "Specification of Transaction Attributes with Metadata Annotations"

Carlo

On 07/05/2011 01:07 PM, Pete Muir wrote:
> I think it's wrong to capitalize every word  except in the title of the guide. I have never seen this done in tech docs.
>
> I am aware of two conventions.
>
> 1) "minor words" - conjunctions, articles, prepositions, pronouns are lower case, whilst nouns, verbs, adjectives, adverbs are capitalised. e.g. "JBoss Application Server 7 is a Extremely Nice Project." "JBoss Application Server 7 Runs in Eclipse Very Well"
>
> or
>
> 2) All words are lower case except proper nouns (just like a sentence).  e.g. "JBoss Application Server 7 is an extremely nice project" "JBoss Application Server run in Eclipse very well".
>
> I think option (2) is by far and away the best. I've looked at the Admin Guide and this is the usage there. There Getting Started Guide almost uses this. I noticed a couple of errors in the Getting Started Developing Applications Guide but this is the style I intended.
>
> On 5 Jul 2011, at 11:56, Kabir Khan wrote:
>
>> The capitalization of the headers in the docs is a bit arbitrary
>>
>> Some Places We Do This
>> Other places use this
>>
>> This needs to be standardized. Either we choose one of the two options or
>>
>> h1 + h2: We Use This
>> h3++: We use this
>> _______________________________________________
>> jboss-as7-dev mailing list
>> jboss-as7-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/jboss-as7-dev
>
> _______________________________________________
> jboss-as7-dev mailing list
> jboss-as7-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/jboss-as7-dev