Document Quality Control 2024
03 DECEMBER, 2024 | By Giulia Romagnoli & Natalya Kahn
If you have any questions or need some help with a document, don’t hesitate to get in touch! More information can be found in EDMS 2907365.
To fit (more or less!) the tune of “The Twelve Days of Christmas”.
On the first day of Christmas, BE-EA sent to me
A lot of acronyms.
On the second day of Christmas, BE-EA sent to me
2 rejected ECRs1
And a lot of acronyms.
On the third day of Christmas, BE-EA sent to me
4 documents to write2
2 rejected ECRs
And a lot of acronyms.
On the fourth day of Christmas, BE-EA sent to me
Loads of updates on an old version3
4 documents to write
2 rejected ECRs
And a lot of acronyms.
On the fifth day of Christmas, BE-EA sent to me
27 BCRs
Loads of updates on an old version
4 documents to write
2 rejected ECRs
And a lot of acronyms.
On the sixth day of Christmas, BE-EA sent to me
37 ARRs and ECRs4
27 BCRs
Loads of updates on an old version
4 documents to write
2 rejected ECRs
And a lot of acronyms.
On the seventh day of Christmas, BE-EA sent to me
53 sets of minutes
37 ARRs and ECRs
27 BCRs
Loads of updates on an old version
4 documents to write
2 rejected ECRs
And a lot of acronyms.
On the eighth day of Christmas, BE-EA sent to me
178 documents to create5
53 sets of minutes
37 ARRs and ECRs
27 BCRs
Loads of updates on an old version
4 documents to write
2 rejected ECRs
And a lot of acronyms.
On the ninth day of Christmas, BE-EA sent to me
228 documents to update6
178 documents to create
53 sets of minutes
37 ARRs and ECRs
27 BCRs
Loads of updates on an old version
4 documents to write
2 rejected ECRs
And a lot of acronyms.
On the tenth day of Christmas, BE-EA sent to me
243 JIRA actions7
228 documents to update
178 documents to create
53 sets of minutes
37 ARRs and ECRs
27 BCRs
Loads of updates on an old version
4 documents to write
2 rejected ECRs
And a lot of acronyms.
On the eleventh day of Christmas, BE-EA sent to me
Many broken cross-references8
243 JIRA actions
228 documents to update
178 documents to create
53 sets of minutes
37 ARRs and ECRs
27 BCRs
Loads of updates on an old version
4 documents to write
2 rejected ECRs
And a lot of acronyms.
On the twelfth day of Christmas, BE-EA sent to me
2262 emails about documents9
Many broken cross-references
243 JIRA actions
228 documents to update
178 documents to create
53 sets of minutes
37 ARRs and ECRs
27 BCRs
Loads of updates on an old version
4 documents to write
2 rejected ECRs
And a lot of acronyms.
1 Unfortunately, ECRs will no longer be approved after completion of the works they describe. If this happens, further documentation will be necessary, including as-built engineering specifications and (potentially) non-conformity reports.
2 We’re always happy to help! Ideally, we wouldn’t write ECRs but if you don’t know where to start, just let us know and we can guide you through the process.
3 If you’re editing a document, please download and use the latest version from EDMS and don’t make changes to your original copy! Before uploading a document to EDMS, we often make small edits (to correct typos or formatting) that you won’t know about, so the EDMS copy is the always the most up-to-date version. Further information about the quality control process can be found at EDMS 2907365 or do feel free to ask us.
4 For YETS 24-25. ECRs are needed for any changes and must be approved before the start of works. ARRs are needed for replacements that affect the beamline. They are used to inform relevant stakeholders and to check whether the change is major enough to need an ECR.
5 Just get in touch if we can help with organising EDMS!
6 Let us know if there are new document versions that need uploading, circulating or proofreading! Current documents can be found and tracked on the JIRA EA documents kanban board.
7 NA-CONS-related actions from TCCs, Board Meetings, ICEA and many other meetings can be found and tracked on the JIRA actions Kanban board.
8 Cross-references should be used for figures, tables and references. Further information can be found in EDMS 2907365 or do feel free to ask us.
9 Just in Natalya’s inbox!