Provide a standard documentation for users of a library for Java.
- Categories
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.
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.
Resources
Information Material
The following list of resources provides background information on creating and working documentation for Java libraries based on the projectdoc Toolbox for Confluence.
| Resource | Short Description | Type |
|---|---|---|
Get started with the projectdoc Toolbox: learning by doing | topic | |
A gentle introduction to page blueprints provided by doctype add-ons. The page blueprints are grouped semantically to make it easier for users to build a conceptual mind map for them. | topic | |
Concepts central to projectdoc. Things users have to understand to get the most out of using projectdoc. | topic | |
Space properties are defined for spaces and are accessed via the Space Property Macro. This tip goes into detail in how to use space properties with inheritence and extension pages. | topic | |
Lists the configuration options at space level. | topic | |
Add-on to extend the projectdoc Toolbox to integrate remote information systems. | topic | |
Add-on to extend projectdoc with an API to access on the web. | topic |
Doctypes
The following doctypes (blueprints based on the projectdoc Toolbox) provided page blueprints to create documentation for a Java library.
| Resource | Short Description | Categories |
|---|---|---|
Properties are part of the configuration options of a system. | ||
Metadata documents provide tables of simple key/value pairs. This information can be used as an aspect or as additional space properties to be available for reference on your wiki. | ||
Document a version of a product or service. | ||
Document requirements you impose on artifacts. Artifacts are created by processes defined and used by the team. This includes assemblies created by the build process, source code artifacts or reports. | ||
Describe the codes that are part of the product's API. | ||
Interfaces document how elements of the system communicate with elements of this and other systems. |
Macros
The following macros of the projectdoc Toolbox support creating or working with documentation for a Java library.
| Resource | Short Description | Categories |
|---|---|---|
Renders a space property value. | Display / Property | |
Renders all properties referenced by the current space. | Development | |
Renders an image generated from an Enterprise Architect diagram, transcluded from a server. | Link / Information System | |
Transclude HTML content from a remote server. | Link / Information System | |
Links API documentation pages for Java elements. | Link / Information System | |
Renders a link to an artifact stored on a Nexus server. | Link / Information System | |
Renders an image transcluded from a remote server. | Link / Information System | |
Links to a resource on a server. | Link / Information System | |
Transclude content from a resource from a remote system. | Link / Information System | |
Transclude text content from a remote server. | Link / Information System |