content of documentation element

MSLNZ / equipment-register-schema

XML Schema Definition (XSD) for an Equipment Register

https://mslnz.github.io/equipment-register-schema/

0 stars 0 forks source link

content of documentation element #4

Open jborbely opened 1 year ago

jborbely commented 1 year ago

The annotation value of the <documentation> element is

Satisfy ISO/IEC 17025:2017 Clause 6.4.13 f) documentation of reference materials, results, acceptance criteria, relevant dates and the period of validity

Also includes the optional information that is specified in Section 4.3.6 of the MSL Quality Manual.

Some items to consider:

is documentation a good name for this element?
does the content satisfy the specified purpose?
should the MSL Quality Manual stuff be moved to a new element?
minOccurs="0" so the content may be empty, is this okay?

rebeccahawke commented 4 months ago

I would suggest to leave this element as 'documentation' and see how it gets used, and to allow individual elements within the element to be empty if not applicable (e.g. we might have a web link for the manual but the equipment might not be related to any technical procedures). Neil might have some quality manager suggestions for what else needs to be included here, and if it does become more 'qualitySystem' related, then a new element that's specific to the quality system could separate out those parts.

jborbely commented 3 months ago

All optional financial metadata has been moved to a <financial> element in 22bb19ae242220bcb408ae551cfe8501260d239f.

An optional <referenceMaterials> element was added in 24afb046b96d709301f923bfb51fb590d11d6e11.

The serviceAgent became an optional attribute of the <maintenance> element in ba083125c5d3529497a96d10835c206cda1c00c6.