Где должна храниться проектная документация в типичном проекте maven

Где следует проектировать документацию (требования и т.д.) в типичном проекте maven.

Ни один из каталогов, перечисленных на странице Введение в стандартный макет каталога, является очевидным кандидатом.

Ответ 1

К сожалению, конвенции нет. Если вы хотите, чтобы документация была частью созданного сайта, очевидно, что /src/site - хорошее место. Возможно, вы даже можете записать документацию в формате APT?

Но более вероятно, что у вас есть набор файлов doc, pdf и xls doc, pdf и xls, графики, сообщений электронной почты и т.д. Вы также можете разместить их под /src/site и разместить гиперссылки на сайте или К сожалению,... определите свое собственное соглашение. Обычно я видел /src/main/doc(s), /src/doc(s) или даже /doc(s).

Вы не хотите размещать свою документацию в /src/main/resources или src/main/webapp, так как файлы будут частью встроенного артефакта (JAR/WAR), который редко требуется.

Ответ 2

http://www.sonatype.com/books/mvnref-book/reference/site-generation-sect-dir-struct.html рекомендует следующую структуру

sample-project
+- src/
[..]
+- resources/
|  +- images/
|  |  +- banner-left.png
|  |  +- banner-right.png
|  |
|  +- architecture.html
|  +- jira-roadmap-export-2007-03-26.html
[..]

Ответ 3

В соответствии с maven-javadoc-plugin:

Параметр <javadocDirectory/> может использоваться для включения дополнительных ресурсов, например HTML или изображений, в сгенерированный javadoc. Затем вы можете ссылаться на эти ресурсы в своих комментариях javadoc. По умолчанию все ресурсы javadoc находятся в каталоге ${basedir}/src/main/javadoc. Обратите внимание, что вам нужно установить параметр docfilessubdirs, чтобы скопировать их.