Create any additional documentation needed for the IEPD, fill out the IEPD catalog, assemble all of the artifacts, and bundle the files into the final IEPD zip file package.
During this process, it may be necessary to go back to earlier steps to fix bugs, update schemas, fill in missing mappings, etc.
At this stage, the schemas and sample instances for the IEPD should be complete. It’s time to finish up the rest of the artifacts and documentation for the IEPD.
See IEPD Artifacts for information about the required artifacts and optional artifacts for an IEPD.
Among the other documentation that is being prepared, make sure to prepare the following required artifacts:
Once all IEPD artifacts have been prepared, the the next step is to compile and archive the final package:
See IEPD Artifacts – Recommended folder layout for the recommended layout of the IEPD directory.
An IEPD Review Process is a good practice to maintain a consistent standard of quality in documents that are accepted for publication in support of organizational information sharing initiatives.
A review process will help to decrease the occurrence of published IEPDs that are difficult to reuse. Peer participation in an IEPD review group also increases individual knowledge of information exchanges and will promote accountability in verifying that the exchange meets established requirements.
While the NIEM Naming and Design Rules (NDR) provides conformance rules and guidances for NIEM schemas and instance documents, it does not address IEPDs. NDR conformance is only part of the requirement for full NIEM IEPD conformance.
The NIEM IEPD Specification provides rules and guidance about the IEPD as a whole, including which artifacts are required and what kind of metadata should be provided.
Checking IEPD conformance is an additional review step that must be taken after the IEPD is fully assembled. Thus, it is not one of the validation steps described in the previous Build and Validate phase of the IEPD lifecycle.
IEPD conformance rules are not automated. ConTesA only checks NDR Schematron rules for schemas and instances. IEPD conformance rules must be checked manually.
To make it easier to identify rules from the IEPD specification and record the results, an IEPD review checklist has been provided. This is a spreadsheet that includes:
Download an IEPD review checklist
Checklists last updated 2021-06-25.
The image below shows several rows from the checklist, along with some example rule status codes filled in.
“Pass” and “fail” status codes are fairly standard for results. “Review” is provided as an additional option to make it easy to identify rows that need to be returned to later for further review.
Some organizations use an IEPD Peer Review Process to establish a standard process for reviewing IEPDs.
During this review process, IEPD developer responsibilities include:
Responsibilities for the review team include:
By the end of this stage, the IEPD should be complete. The package should contain all required artifacts, including extension and NIEM subset schemas, an IEPD catalog, a readme, a change log, and a conformance assertion. Many other kinds of documentation and artifacts can be included as well. The final package should be zipped and ready for distribution and implementation.