Documentation

gitHub

Tutorial

We try real hard to make Hackolade Studio as intuitive as possible with a minimalist design, and we avoid to bloat the software with functionality that few people ever use.  In reality, the use cases for the tool are quite simple:

  • start from a blank page, construct your data structures, then forward-engineer artifacts to be consumed by target technologies or data citizens;
  • or reverse-engineer an existing instance, enrich the model with descriptions and constraints, then publish the documentation

 

The complexity appears when diving deeper in each of the use cases.  NoSQL and JSON seem simple from the outside, but their power and flexibility offer many permutations that end up increasing complexity.  With Hackolade Studio, we try to deal with this complexity in simpler ways, and only when necessary.  For example, we allow non-technical users to generate JSON Schema files without requiring any knowledge of JSON Schema syntax.  Or for such users to create REST APIs without any knowledge of Swagger/OpenAPI specification syntax.

 

As a result, you don't need extensive training to create a simple data model.  But to be a power user, you need to be aware of all the bells and whistles provided to handle real-life situations.

 

People learn in different ways:

 

We try to accommodate whatever method works for our users.

 

Some people like the linear flow of outlines, while others prefer non-linear mindmapping.  In addition to the tutorial pages below, we have started an experimental mindmap on this Miro page.  There are 2 views: a functional view, and a user interface view.  In the boxes of each view, you can click on the hyperlink to a page of this online documentation.

 

Miro functional view

 

and

Miro UI view

 

Don't hesitate to let us know your feedback and suggestions for improvement.