-
Notifications
You must be signed in to change notification settings - Fork 13
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
Docs: add a page on date fields across the schema #387
Comments
Need to check how much of this can be resolved/changed as part of #469 |
Good documentation about the correct use of date fields for publishers is important to change over time updates #392 |
Work in progress on date formats across the BODS 0.4 schema is here #486. |
The crucial date fields to cover in this guidance page will be:
Producing this page for the 0.4 release is likely to raise questions about republishing and provenance. Reflections and insights can be stashed on that feature ticket for revisiting later, if necessary. @Blueskies00 - assigning to you. This should be an interesting bit of work. |
With @Blueskies00 on leave, I'm assigning over to you @kathryn-ods . This page in the 'Building an auditable record of beneficial ownership' technical guidance sets out our general thinking on dates in BO data. I find this diagram helpful when I think about information flow and time. Also, in addition to the list of date fields above, you may want to mention: |
@kathryn-ods - the other thing to bear in mind as you approach this, is how this documentation fits with the planned new page 'Representing record updates'. I think this is an open question for now. Focusing on what the normative guidance is re representing dates in BODS data will probably be a good starting point. |
Thanks Kadie starting the reading today |
@kd-ods please could you have another look over the edits I have made this morning? https://docs.google.com/document/d/1ZufLxRGTslgPedoixNLDlg13DXioyoIFV0r2I2E5mGo/edit?usp=sharing |
@kathryn-ods - looking good! I don't think it's worth doing much more work on it until I've started work on the new 'Representing record/information updates' page. So that we can fit it all together neatly. |
I've taken a look at this and left a few comments. I have an observation... but no idea what to do about it. This is going to be one of the only pages we have which is in the Data standard section but contains no normative content. It really is just additional guidance. (But it is really useful additional guidance imo since it brings all the important date fields together and shows how you can recreate a timeline from them.) I think we probably leave it in that section for the moment, but when we have a few non-normative guidance pages we should group them together elsewhere in the docs. |
Date fields are scattered across the schema's statements and it can be difficult for publishers and data users to understand the different meanings of the fields. E.g.
A dedicated docs page could address all the different types of dates and their meanings. (There's a useful list here of dates in the schema.)
The text was updated successfully, but these errors were encountered: