일반적인 Maven 프로젝트에서 프로젝트 문서를 어디에 저장해야합니까?

일반적인 Maven 프로젝트에서 프로젝트 문서를 어디에 저장해야합니까?

---

일반적인 Maven 프로젝트에서 프로젝트 문서 (요구 사항 등)를 어디에 저장해야합니까?

표준 디렉토리 레이아웃 소개 페이지에 나열된 디렉토리 중 어느 것도 확실한 후보가 아닙니다.

---

불행히도 컨벤션이 없습니다. 문서가 생성 된 사이트의 일부가되기를 원한다면 분명히 /src/site좋은 곳입니다. APT 형식으로 문서를 작성할 수도 있습니까?

그러나 doc, pdf및 xls파일, 그래픽, 이메일 등 의 세트가있을 가능성이 높습니다 . /src/site사이트에 하이퍼 링크를 배치하거나 ... 슬프게도 자신의 규칙을 정의 할 수도 있습니다. 일반적으로 나는 보았다 /src/main/doc(s), /src/doc(s)또는 /doc(s).

파일은 거의 원하지 않는 빌드 된 아티팩트 (JAR / WAR)의 일부가되므로 /src/main/resources또는에 문서를 배치하고 싶지 않습니다 src/main/webapp.

---

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
[..]

---

maven-javadoc-plugin 에 따르면 :

이 <javadocDirectory/>매개 변수는 생성 된 javadoc에 HTML 또는 이미지와 같은 추가 자원을 포함하는 데 사용할 수 있습니다. 그런 다음 javadoc 주석에서 이러한 리소스에 연결할 수 있습니다. 기본적으로 모든 javadoc 자원은 ${basedir}/src/main/javadoc디렉토리에 있습니다. docfilessubdirs이를 복사 하려면 매개 변수를 설정해야합니다 .

참조 URL : https://stackoverflow.com/questions/9135477/where-should-project-documentation-be-stored-in-a-typical-maven-project