Child pages
  • User Documentation for Java Library

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleDescription
 
Section
show-titlefalse
titleSummary

Teams using continuous deployment may choose to create libraries to modularize their code base. Each library is a product of its own with its own release cycle. Especially if the library is made public available, a sound and similar structure of the documentation helps developers to find information on how to use this library easily.

To create a user documentation for a library for Java the projectdoc for Java Developers Add-on for the projectdoc Toolbox provides tools to import information from a Maven POM file. This way all properties specified by the developers are accessible as space properties by authors of the documentation.

Caution Box
titleExperimental Add-on!

The projectdoc for Java Developers Add-on is available on the Atlassian Marketplace and on Bitbucket. It is still considered to be experimental. So expect to encounter some rough edges.

Please get in touch if you have suggestions for improving the add-on or fork it on Bitbucket!

Example for a Library Documentation with Confluence and the projectdoc Toolbox

This approach does require to create a Maven Site with all reports (for example Javadoc Report, Source Code Report, or Changes Report) and link to or transclude from this information. The Information Systems Extension provides macros to access information from remote servers.

...