Details
-
New Feature
-
Status: Closed
-
Major
-
Resolution: Auto Closed
-
None
Description
(The following text was ripped from MSITE-281)
Make changes (mostly typographic) intended to improve readability/consistency of the documentation. Some of the rules I chose to follow are surely controversial and a matter of taste:
- Hyperlinks should be readable/understandable without their surrounding context (a best practice for web design, e.g. see Stanford Online Accessibility Program)
- Headline style capitalization for page/section titles (see also Capitalization of Headings and Titles)
- Double quotation marks instead of single quots for quoted text (Quotation Marks and Direct Quotations)
- Proper casing for acronyms (e.g. POM instead of pom, but scp if one wants to refer to the protocol part of a URL literally)
- Monospaced font for file/path names, URLs, plugin goals, command prompts
- Uppercase first letter for plugin names (it might just be my German habit, but I consider "the Clean Plugin" more understandable than "the clean plugin" since I can realize the reference to a name more quickly)
It might by worth to create some guidelines (house-style) that Maven developers can follow for their documentation, similar to the Maven Plugin Documentation Standard and the code formatter style.