- Knowing how many data modules comprise your S1000D project(s).
- Knowing where these data modules are coming from (your team, vendors, etc.).
- Managing multiple SNS schemes (yours, your vendors)
- Managing vendors’ data modules
- Ability to efficiently build a list of all necessary data modules
- Tying this list to a ‘stub-out’ of the data modules themselves (i.e., create a rudimentary XML document for each and every data module in your project).
Look for posts, additions to our website, and email notifications in the coming weeks. We are excited about these applications and rolling them out to general availability. If you want a sneak peek, contact us at firstname.lastname@example.org
The Business Rules Exchange Data Module (BREX DM) is used to programmatically enforce business rules that govern what can and cannot appear in an S1000D data module’s content. The BREX DM uses XPath statements that verify that authored content conforms to the project’s business rules. For example: to ensure consistency in the units of measurement used in a program a BREX rule could specify and enforce the use of only metric values.
Note: There are business rules that are defined by a project that cannot be enforced programmatically. Business rules that cover general policy (such as publishing to an IETM environment) are dictated in a Business Rule document, but are not part of the BREX.
At a company that I once worked for (I won’t name names, but they once enjoyed a good reputation in the SGML/XML world), we developed and marketed a process for how data moved through a system, from creation to distribution. It served as a very effective tool for explaining to our customers exactly what we did and why our services were valuable.
I think a similar approach is needed for detailing the activities in instantiating an S1000D-based system. I’ll come up with a fancy term such as “S1000D Process” – see Mom, all my years of schooling are finally paying off!
The S1000D Process:
We have identified six components of the S1000D process:
- Determine which version of S1000D you are going to use.
- Identify content to be managed.
- Determine data module granularity.
- Determine publishing strategy (electronic, print, both).
- Complete the Functionality Matrix available from the S1000D website.
- Business Rule Definition
- Detail your S1000D business rules.
- Determine which rules can and should be enforced by the BREX.
- Generate or develop your BREX document.
- CSDB Selection
- Determine which tool best fits your organization’s needs.
- Decision is based on S1000D version, existing infrastructure, desired functionality and, of course, $$$.
- Note this right off the bat: You WILL need customizations.
- CSDB Implementation
- Integrate with existing systems.
- Develop customizations to fulfill the totality of your requirements.
- Coordinate with engineering.
- Technical writers are creating content utilizing S1000D schemas and the appropriate BREX document.
- Create illustrations.
- Publishing and Distribution
- Publish to electronic and/or print.
- Distribute worldwide!