Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

As an architect, I need information organized by messages, so I can comprehend an event driven system #14

Closed
sync-by-unito bot opened this issue Mar 10, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@sync-by-unito
Copy link

sync-by-unito bot commented Mar 10, 2022

This is a request to create a new section in the hugo translator's output that organizes information focusing on message types, how they are used, where they are defined, and where in the hierarchy they exist.

Message types are the four DDD types: command, event, query, and result. The documentation for every leaf subdomain should have four pages added, one for each kind of message type. Those pages should list all the messages of their type that are USED by the subdomain (all contexts) but none that are merely accessible by the subdomain. Ideally, that wouldn't happen, but in practice, it will.

Each page contains a list of relevant messages. Each row in that list starts with the name of the message and then a set of tabs:

  • Type - shows the fields of the message, with their brief descriptions if any
  • Defined In - shows the subdomain, context, entity, or other definition in which the message is defined, along with that definition's brief description
  • Used In - shows the places from which this message is used with full path identification, and each path component is a link to the documentation for that definition.
  • Description - Full description of the message as defined in its "described by" type which could be fairly involved with diagrams, etc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant