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

Make spec document more implementor centric #62

Closed
lukasj opened this issue Nov 2, 2020 · 1 comment
Closed

Make spec document more implementor centric #62

lukasj opened this issue Nov 2, 2020 · 1 comment

Comments

@lukasj
Copy link

lukasj commented Nov 2, 2020

Going through current spec, it feels to me more like a user-guide for particular implementation.
While having descriptive examples may be good thing to have there, I'd expect the spec document to be more "implementor centric" with defined requirements for the implementor. A user guide of particular implementation seems to be better place for (more) detailed examples as it may use also implementation-specific features.

@keilw
Copy link
Member

keilw commented Nov 2, 2020

Thanks, we appreciate input by @lukasj, @m0mus or maybe @cfsilence who I just learned about his role at Oracle during JCON last week.
There have to be multiple documents, not only spec, but also TCK and implementor guides. https://github.com/eclipse-ee4j/jsonb-api also has a "docs" and "spec" module with two separate documents.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants