Assemble and Document is the next phase in IEPD development after the Build and Validate phase.
You have all of your mandatory and recommended artifacts ready. Now you need to gather all of it in one electronic package.
As a starting point, logically organize the Readme document in chronological order of the development artifacts. Existing IEPD master documents can be used as a general guide. The Readme document can be a simple-text file and should not include XML code.
The following is a recommended, general-purpose table of contents.
- Executive Summary
- [Name] Information Exchange
- Overview of the [Name] Exchange
- Exchange Partner Interaction
- Business Models
- Business Rules and Requirement
- Exchange Content Model
- Development Information
- IEPD Definition
- Tools and Methodologies
- Testing and Conformance
- List of IEPD Artifacts
- IEPD Catalog
The Change Log can be a simple-text file.
Version Date Description Author 1.0 2/2/03 Original Version Bob 1.1 4/16/03 Added new elements to subset schema. Bill 2.0 5/9/18 Updated requirements and constraint schema. Sara
Once all the artifacts have been compiled, the next step is to properly name, file, and archive the final package.
A standardized file structure promotes consistency and creates logical navigation through a large number of IEPD artifacts. Moreover, this consistency enables a greater degree of discovery and IEPD reuse because you can easily access information in a structured and uniform manner. Note that the catalog enables IEPD developers to locate artifacts in a directory and label them as specific IEPD artifacts no matter where they exist in the package.
The following example shows a recommended IEPD folder structure and file location.
The documentation produced by the SSGT creates some of the structure for you.
The root directory name should be meaningful and include the NIEM version and a revision number.
- xml-catalog.xml (references extension uri and nextCatalog niem/xml-catalog.xml)
- documentation (miscellaneous, binaries)
- iep-sample (contains sample xml instances; must be in root directory)
- iepd-catalog.xml (must be in root directory)
- changelog.txt (.md, .htm, .pdf; must be in root directory)
- readme.txt (.md, .htm, .pdf; must be in root directory)
- conformance-assertion.txt (.md, .htm, .pdf; should be in root directory)
- schematron (if Schematron is used; should be in root directory)
You should perform a peer review of your IEPD. This has several benefits:
A good way to review an IEPD is to compare it to a checklist. The checklist should include the following: