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(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/jboss-as7-dev

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(a)lists.jboss.org > https://lists.jboss.org/mailman/listinfo/jboss-as7-dev _______________________________________________ jboss-as7-dev mailing list jboss-as7-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/jboss-as7-dev

h3++! Sentence case is better than Title Case. ----- Original Message ----- > From: "Kabir Khan" <kabir.khan(a)jboss.com&gt; > To: "JBoss AS7 Development" <jboss-as7-dev(a)lists.jboss.org&gt; > Sent: Tuesday, July 5, 2011 8:56:06 PM > Subject: [jboss-as7-dev] Documentation headers > 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(a)lists.jboss.org > https://lists.jboss.org/mailman/listinfo/jboss-as7-dev -- Misty Stanley-Jones, RHCE Content Author, ECS Brisbane ☺: misty (Freenode IRC) ✉: misty(a)redhat.com ☏: +61 7 3514 8105 ☏: 88105 _______________________________________________ jboss-as7-dev mailing list jboss-as7-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/jboss-as7-dev