Posts Tagged‘S1000D Process’

Two New S1000D Applications

It’s March already! Where does the time fly? In Texas we decided to skip winter altogether. We have flowers blooming and, at present, I’m typing this with the windows to the office wide open.

Ahead of changes to our website and the various marketing initiatives that businesses must take when rolling out new products, I wanted to let you know that We are going to be rolling out a couple of new applications during March:

BREXCheck™ and S1000D Architect™.

BREXCheck™ – BREXCheck allows for on-the-fly BREX validation while creating S1000D content. It can work in the XML editor of your choice. Technical authors and content creators author their S1000D data modules as normal. BREXCheck operates in the background. If the author attempts to enter an element that is dissallowed, or an incorrect attribute value, BREXCheck will offer a notification. This should greatly speed up and improve the S1000D authoring and the QA processes.

The second is S1000D Architect™, which is a layer of logic that sits on top of an S1000D CSDB (Content Storage Data Base). S1000D Architect allows you to truly control and manage your S1000D project(s). Management of your S1000D project(s) includes:

  • 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 info@crowsol.com

 

Sincerely,

 

Rick

 

 

 

BREX Data Module: What, Why, Who, When, Where & How

What?

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.

Continue Reading

The Stages of an S1000D Project

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:

  1. Setup
    1. Determine which version of S1000D you are going to use.
    2. Identify content to be managed.
    3. Determine data module granularity.
    4. Determine publishing strategy (electronic, print, both).
    5. Complete the Functionality Matrix available from the S1000D website.
  2. Business Rule Definition
    1. Detail your S1000D business rules.
    2. Determine which rules can and should be enforced by the BREX.
    3. Generate or develop your BREX document.
  3. CSDB Selection
    1. Determine which tool best fits your organization’s needs.
    2. Decision is based on S1000D version, existing infrastructure, desired functionality and, of course, $$$.
    3. Note this right off the bat: You WILL need customizations.
  4. CSDB Implementation
    1. Integrate with existing systems.
    2. Develop customizations to fulfill the totality of your requirements.
  5. Authoring
    1. Coordinate with engineering.
    2. Technical writers are creating content utilizing S1000D schemas and the appropriate BREX document.
    3. Create illustrations.
  6. Publishing and Distribution
    1. Publish to electronic and/or print.
    2. Distribute worldwide!

–Rick