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

Document database features #295

Open
mdabrowski1990 opened this issue Nov 7, 2024 · 0 comments
Open

Document database features #295

mdabrowski1990 opened this issue Nov 7, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@mdabrowski1990
Copy link
Owner

Description

As a user, I would like to have proper documentation, so I can understand how to create new databases and what is already implemented.

Testing

  • review

Acceptance Criteria

  • user guide documentation is extended
    • database object usage is explained
      • encoding and decoding diagnostic messages (including inputs and outputs)
    • abstract service is explained
      • how to implement your own service decoder
    • data record is explained
      • each type is listed
      • use case of each data record type is explained
@mdabrowski1990 mdabrowski1990 added the documentation Improvements or additions to documentation label Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant