maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Osipov (JIRA)" <j...@apache.org>
Subject [jira] [Closed] (MNGSITE-43) Create writing style guidelines
Date Sun, 06 Sep 2015 20:45:10 GMT

     [ https://issues.apache.org/jira/browse/MNGSITE-43?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Michael Osipov closed MNGSITE-43.
---------------------------------
    Resolution: Auto Closed

This issue has been auto closed because it has been inactive for a long period of time. If
you think this issue still applies, retest your problem with the most recent version of Maven
and the affected component, reopen and post your results.

> Create writing style guidelines
> -------------------------------
>
>                 Key: MNGSITE-43
>                 URL: https://issues.apache.org/jira/browse/MNGSITE-43
>             Project: Maven Project Web Site
>          Issue Type: New Feature
>            Reporter: Benjamin Bentmann
>
> (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|http://soap.stanford.edu/show.php?contentid=46])
> - Headline style capitalization for page/section titles (see also [Capitalization of
Headings and Titles|http://www.tc-forum.org/topicmai/ml03capi.htm])
> - Double quotation marks instead of single quots for quoted text ([Quotation Marks and
Direct Quotations|http://www.informatics.sussex.ac.uk/department/docs/punctuation/node30.html])
> - 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|http://docs.codehaus.org/display/MAVEN/Maven+Plugin+Documentation]
and the code formatter style.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message