Apache Maven engineering documentation

Maven - Engineering documentation

This tutorial will teach you how to create documents for your application. S o let's get started, in C:/ U nder the MVN directory, create your java consumerBanking application. Open the consumerBanking folder and execute the following mvn command.

C:\MVN>mvn site

Maven will begin construction.

[INFO] Scanning for projects...
[INFO] -------------------------------------------------------------------
[INFO] Building consumerBanking
[INFO]task-segment: [site]
[INFO] -------------------------------------------------------------------
[INFO] [site:site {execution: default-site}]
[INFO] artifact org.apache.maven.skins:maven-default-skin: 
checking for updates from central
[INFO] Generating "About" report.
[INFO] Generating "Issue Tracking" report.
[INFO] Generating "Project Team" report.
[INFO] Generating "Dependencies" report.
[INFO] Generating "Continuous Integration" report.
[INFO] Generating "Source Repository" report.
[INFO] Generating "Project License" report.
[INFO] Generating "Mailing Lists" report.
[INFO] Generating "Plugin Management" report.
[INFO] Generating "Project Summary" report.
[INFO] -------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] -------------------------------------------------------------------
[INFO] Total time: 16 seconds
[INFO] Finished at: Wed Jul 11 18:11:18 IST 2012
[INFO] Final Memory: 23M/148M
[INFO] -------------------------------------------------------------------

Open the C:\MVN\consumerBanking\target\site folder. Click on the index .html and you'll see the document.

Maven creates documents using a file processing engine called Doxia, which transforms files in multiple source formats into a common document model. To write engineering documents, you can write in the following common formats that can be parsed by Doxia.