JarCasting
Read CONTRIBUTING file to contrib and check the the backlog on the trello board : https://trello.com/b/pabtQSZG/living-documentation
Living documentation tools
This project is intended to provide some tools to allow a nice Living Documentation.
It based on Asciidoctor, Plantuml Builder, and other nice tools…
See examples to show the powerfull ! You’ll be able to generate beautiful documents with a simple configuration. Create a living documentation from the code automatically. Easily customizable.
With or without annotations.
This java project is made of :
-
Some java annotations (like UbiquitousLanguage annotation), but not mandatory
-
A fully customizable maven plugin
Generate a conception diagram (svg format with link supported !)
And a business glossary (with asciidoc syntax, also in table format)
Add gherkin description :
You can also integrate gherkin files like this example : Microservice example generated index file
Also allow to publish generated docs to confluence :
Publish specific HTML version to Altassian Conlluence Server.
With a light maven configuration :
<plugin>
<groupId>ch.ifocusit.livingdoc</groupId>
<artifactId>livingdoc-maven-plugin</artifactId>
<version>1.2</version>
<executions>
<execution>
<id>class-diagram</id>
<phase>package</phase>
<goals>
<goal>diagram</goal>
<goal>glossary</goal>
</goals>
</execution>
</executions>
<configuration>
<packageRoot>ch.ifocusit.telecom.domain</packageRoot>
<interactive>true</interactive>
<excludes>
<exclude>.*domain.common.*</exclude>
</excludes>
</configuration>
</plugin>
See livingdoc-examples for more uses cases.
Coin des développeurs : readme développeur