Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 1.49 KB

ex_living_glossary.adoc

File metadata and controls

83 lines (59 loc) · 1.49 KB
Raw

Living glossary

  • Generated from code

  • Make Business Knowledge accessible

  • Makes knowledge mistmatch visible

  • Leads to Ubiquitous Language

Use code to generate a glossary that can be read by business people. They can say if a word is not exactly good. It can be changed from the code.

Input • Code

Java files with marker annotations (ex. @Aggregate, @Entity). Inspiration for such annotations are shown in Patternity by Cyrille Martraire.

ShoppingCart.java

Input • Code

package com.organisation.domain.order;
/**
 * A shopping cart blah blah blah.
 */
@Aggregate
public class ShoppingCart{
    // ...
}

Input • Code

ShoppingCartItem.java

package com.organisation.domain.order;
/**
 * An item that is hold the shopping cart to be ordered.
 */
@Entity
public class ShoppingCartItem{
    // ...
}

Output • Markdown

# Order

[Link](/src/main/java/com/organisation/domain/order/)

## Shopping Cart

A shopping cart blah blah blah.

[Link](/src/main/java/com/organisation/domain/order/ShoppingCart.java)

### Shopping Cart Item

An item that is hold the shopping cart to be ordered.

[Link](/src/main/java/com/organisation/domain/order/ShoppingCartItem.java)