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.

Sign up for GitHub

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

Jump to bottom

The tables of layered requirements are unusable #2

Open

richard-jones opened this issue Dec 12, 2019 · 1 comment

Labels

review

Contributor

richard-jones commented Dec 12, 2019

They are technically correct, which means they probably do form the basis of the specification, but actually working from them is impossible.

The "SWORD3 Behaviours" document is much much better for implementers, and is not presented prominently.

We should consider making the requirements tables less prominent and encouraging use of the de-normalised behavioural document.

This is also true of the "Content Disposition" section as it is the Protocol Requirements section.

Contributor Author

richard-jones commented Jul 8, 2020 •

edited

Loading

Rewrite the whole of section 8 to use a different presentation
Improve the visibility of the link to the sword behaviours document in section 8
Rewrite the whole of section 12 to use a different presentation
Improve the visibility of the link to the sword behaviours document in section 12

richard-jones added the review label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment