Menu
Our team is starting to implement event driven designs. We are now figuring what's the best tool/s and practices for documenting the schema of these events.
What are the common tools used for this use case?
Any links or suggestions is appreciated.
885
4. Documentation generators (read only) There is a number of dedicated tools whose sole purpose is to generate documentation from your database schema. This category of tools doesn't have any editing capabilities and can only generate a documentation from metadata extracted from the database.
Wrike is a work management solution that allows teams to collaborate with ease. It has several of the features of some of the other tools on our list, which makes it a good option for companies looking for more than just a tool to create and manage their process documentation.
The Event schema defines the following elements and types that identify the elements and attributes of a logged event: The elements section contains the names of the elements that you would find in a logged events; however, to get the details for each element, see the complex type that contains the element.
Basecamp is one of the original project management tools that many event planners use. You can sign up for a 30-day free trial, then pay a flat fee per month with no per-user fees.
I would start off with the common CloudEvents spec and model my events based on that, i.e., define the events as subtypes of the generic CloudEvent model. The benefit here is interoperability with other systems based on the same spec as well as the existing tooling such as language SDKs.
As for documentation, I'd go for JSONSchema: here's the JSONSchema definition for a generic CloudEvent for example.
As an alternative, there's the AsyncAPI specification which you can use instead of or together with CloudEvents: read here on how the two relate.
175
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
