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

Data descriptive labels and field names MUST match the "Guide to Field Names" (...fix the Guide if necessary) #9

Open
jpotvin opened this issue Oct 28, 2020 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation fix request This feature must be fixed.

Comments

@jpotvin
Copy link

jpotvin commented Oct 28, 2020

In https://xalgo-rm-components-sample-application.netlify.app/editor we have
Input: Contexts
Jurisdictions
Country Jurisdiction
Sub-Country Jurisdiction

But in https://xalgo-system.herokuapp.com/apps/rm/editor/353f82b7-c52d-4539-bade-872f54ca4512 we have
Input: Contexts
Data Sources
Jurisdiction
Sub-Jurisdiction

In the Guide to Field Names I specified the following use-friendly questions:
WHERE AND WHEN THIS RULE IS ASSERTED TO BE "IN EFFECT"
What is the country jurisdiction of the organization or person declaring this to be a rule?
What is the state/province/territory/region jurisdiction (one level below the 'country') of the organization or person declaring this to be a rule?

... and the fieldnames would be called:
INPUT.CONTEXT
jurisdictions.country
jurisdictions.subcountry

  • I indended for those short questions to be the labels for each field (rather like filling in an income tax form).
  • I did not intend for the concatenated fieldnames themselves to be used for communication with the end-user Author.
  • The Guide to Field Names needs to be implemented exactly as it is the thoroughly-considered core data structure. If it contains a problem it needs to be fixed. We cannot have any mismatch between the (latest) Guide to Field Names and the implemented data names and prompts.
@jpotvin jpotvin added documentation Improvements or additions to documentation bug Something isn't working labels Oct 28, 2020
@jpotvin
Copy link
Author

jpotvin commented Oct 28, 2020

Also "Name & Description" shows up in an odd place before the "Start Date". (The label "Name & Description" should be removed from there.)
And "End Date" is mis-labelled as "Start Date"
Where does the text "Standard Role Name" come from?

...all in all, non-conforance to the Guide to Field Names makes the logic of the form hard to use.

@millenniallglyphs
Copy link
Contributor

I made some changes for today, but we should come back to this + determine a strategy for managing all the labels, hints, heuristics, etc.

@RyanFleck RyanFleck added fix request This feature must be fixed. and removed bug Something isn't working labels Nov 11, 2020
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 fix request This feature must be fixed.
Projects
None yet
Development

No branches or pull requests

3 participants