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

Docs: add a page on date fields across the schema #387

Closed
kd-ods opened this issue Dec 9, 2021 · 11 comments · Fixed by #634
Closed

Docs: add a page on date fields across the schema #387

kd-ods opened this issue Dec 9, 2021 · 11 comments · Fixed by #634

Comments

@kd-ods
Copy link
Collaborator

kd-ods commented Dec 9, 2021

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.

statementDate vs publicationDetails.publicationDate.

Is the purpose of having the two separated that statementDate is when the statement was submitted but that it might not be published till a later date depending on the cadence with which a register is updated, hence need for publicationDetails.publicationDate to show that information may be published on a date quite different/later than the date the statement was first made.

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.)

@lgs85
Copy link
Contributor

lgs85 commented Jan 18, 2023

Need to check how much of this can be resolved/changed as part of #469

@StephenAbbott
Copy link
Member

Good documentation about the correct use of date fields for publishers is important to change over time updates #392

@lgs85 lgs85 added this to the BODS v0.4 release milestone Jan 18, 2023
@kd-ods kd-ods added the dates label May 8, 2023
@kd-ods kd-ods moved this from 📋 To Do - Tasks to 🔖 Ready in Release tracker: BODS version 0.4 May 16, 2023
@kd-ods
Copy link
Collaborator Author

kd-ods commented Sep 18, 2023

Work in progress on date formats across the BODS 0.4 schema is here #486.

@kd-ods
Copy link
Collaborator Author

kd-ods commented Dec 19, 2023

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.

@kd-ods
Copy link
Collaborator Author

kd-ods commented Jan 10, 2024

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:

@kd-ods
Copy link
Collaborator Author

kd-ods commented Jan 10, 2024

@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.

@kathryn-ods
Copy link
Contributor

Thanks Kadie starting the reading today

@kathryn-ods kathryn-ods moved this from 🔖 Ready to 🏗 In progress in Release tracker: BODS version 0.4 Jan 11, 2024
@kathryn-ods
Copy link
Contributor

@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

@kd-ods
Copy link
Collaborator Author

kd-ods commented Jan 19, 2024

@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.

@kd-ods kd-ods self-assigned this Mar 26, 2024
@kd-ods
Copy link
Collaborator Author

kd-ods commented Apr 1, 2024

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.

@kathryn-ods kathryn-ods moved this from 🏗 In progress to 👀 In review in Release tracker: BODS version 0.4 Apr 11, 2024
@kathryn-ods kathryn-ods mentioned this issue Apr 11, 2024
7 tasks
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Release tracker: BODS version 0.4 Apr 16, 2024
@kathryn-ods kathryn-ods moved this from ✅ Done to Added to Changelog in Release tracker: BODS version 0.4 May 2, 2024
@kathryn-ods kathryn-ods moved this from Added to Changelog to ✅ Done in Release tracker: BODS version 0.4 May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

5 participants