[ 
https://issues.apache.org/jira/browse/MNGSITE-397?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17071746#comment-17071746
 ] 

Elliotte Rusty Harold commented on MNGSITE-397:
-----------------------------------------------

In general, prefer active voice to passive voice in technical writing. Also 
omit needless words. So instead of "Maven allows a project to be built" try 
"Maven builds a project".

Shorter, simpler, more direct. 





> Improve wording on `Providing a uniform build system` in `Introduction`
> -----------------------------------------------------------------------
>
>                 Key: MNGSITE-397
>                 URL: https://issues.apache.org/jira/browse/MNGSITE-397
>             Project: Maven Project Web Site
>          Issue Type: Improvement
>            Reporter: Edinson E. PadrĂ³n Urdaneta
>            Priority: Trivial
>              Labels: docuentation
>          Time Spent: 20m
>  Remaining Estimate: 0h
>
> The current text is
> {quote}Maven allows a project to build using its project object model (POM) 
> and a set of plugins that are shared by all projects using Maven, providing a 
> uniform build system. Once you familiarize yourself with how one Maven 
> project builds you automatically know how all Maven projects build saving you 
> immense amounts of time when trying to navigate many projects.
> {quote}
> I think this way reads better:
> {quote}Maven allows a project to be built using its project object model 
> (POM) and a set of plugins that are shared by all projects using Maven, 
> providing a uniform build system. Once you familiarize yourself with how one 
> Maven project builds, you automatically know how all Maven projects build, 
> saving you immense amounts of time when trying to navigate many projects.
> {quote}
> Changing "to build" with "to be built" and adding a couple of commas.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to