[jboss-as7-dev] Documentation - Naming conventions

[Misty Stanley-Jones]

For the Enterprise docs, we do not shorten the name. We use "Enterprise Application Platform" in all cases. I have seen a directive to use "JBoss Enterprise Application Platform, provided by Red Hat" at the first instance, and shorten that to "JBoss Enterprise Application Platform." However, that has not caught on. Specifically, we do not ever shorten it to EAP, even though it would probably make our lives easier if we could.

----- Original Message -----
> From: "Pete Muir" <pmuir at redhat.com>
> To: "JBoss AS7 Development" <jboss-as7-dev at lists.jboss.org>
> Cc: "Misty Stanley-Jones" <misty at redhat.com>
> Sent: Monday, July 4, 2011 9:26:02 PM
> Subject: Documentation - Naming conventions
> I've seen various ways of referring to the project which we are
> documenting. Normally "JBoss Application Server" is used in the
> introduction to a guide, and then shortened. Some guides use "JBoss
> Application Server 7". There is also some inconsistency with using
> "the JBoss Application Server". I think we should pick one of these
> (my vote is "JBoss Application Server" with no preceding definite
> article, you would still want to use a definite article when referring
> to "the application server" - the difference being that we are using a
> description of the project, not the project name).
> 
> The shorted version is then sometimes referred to as "JBoss AS",
> sometimes as "AS", sometimes as "AS7", sometimes as "AS 7". My pick
> would be "JBoss AS".
> 
> I think it's fairly important we use a single convention so that
> people get a consistent experience with our docs. What do others
> think? Misty, what do you use for the enterprise docs - that could be
> a good convention to adopt (swapping EAP -> AS).

-- 


Misty Stanley-Jones, RHCE 
Content Author, ECS Brisbane 
☺: misty (Freenode IRC) ✉: misty at redhat.com ☏: +61 7 3514 8105 ☏: 88105