Process for developing a Capability

The capability development process is shown in figure 1 below.

Figure 1 —  The capability development process.

The process for building a capability is as follows.

1. Name the capability
   Decide whether the capability is:
   • assigning an object to something, in which case the capability should be named "Assigning_X" where X the object being assigned.
   • representing something, in which case the capability should be named "Representing_X" where X the object being represented.
   • referencing something, in which case the capability should be named "Referencing_X" where X the object being referenced.

2. Generate the capability XML files
   Run the script: dexlib/utils/dex/mk_capability.wsf

   This will generate a set of xml files for the capability stored in: dexlib/data/capabilities/CAPNAME where CAPNAME is the name of the capability.

   The directory dvlp is used for storing issues against the capability and development files such as VISIO files.

   The directory images is used for images that are part of the capability.

   capability.xml is the file which the developer should edit. It provides an XML skeleton for the capability that must be filled out. The file contains XML comment in each section explaining what the developer must document.

3. Update dex_index.xml
   Once the capability XML has been created using dexlib/utils/dex/mk_capability.wsf the capability should be added to the file: dexlib/dex_index.xml so that it can be browsed to. It is recommended that the capabilities are stored in the file in alphabetical order.
4. Add to sourceforge
   Once the capability XML has been created and dexlib/dex_index.xml updated, the capability should be checked in to SourcForge. Make sure that you add all the capability directories, such as images, sys, dvlp otherwise DEXlib will not work for others.
5. Perform review
   When the capability is completed it should be reviewed. The review activity is explained in the Capability Review Checklist Template .

Capability contents

The XML generated by the dexlib/utils/dex/mk_capability.wsf includes a number of inline comments. These provide guidance on the how to develop the content of the capability.

The DTDs also contain documentation of the available XML elements. See:

dexlib/dtd/dex/capability.dtd

The DTD for the capability.

dexlib/dtd/dex/dexdoc.ent

The DTD for the sections common to DEXs and capabilities.

dexlib/dtd/dex/text.ent

The DTD for the text elements. These are primarily HTML, but include a number of elements specific to dexlib.

Process for building a Capability Template

When a capability is created using dexlib/utils/dex/mk_capability.wsf an XML skeleton is created in the capability.xml file. This should be edited according to the requirements of a template. The XML includes includes a number of inline comments. These provide guidance on the how to develop the content of the template. As well as the inline comments, details of the template language are provided at Reading Templates .

The DTDs also contain documentation of the available XML elements. See:

dexlib/dtd/dex/template.dtd

The DTD for the templates.

How to define a Capability

THIS IS AN OLDER TEXT FROM dex-devguide.xml THAT SHOULD BE MERGED WITH THE TEXT ABOVE.
How to establish a new capability

• When defining a new capability, a request shall be sent to the organisation or person who is responsible for the management of the capabilities.
• For each capability, determine the stepmod modules it requires. Write initial additional text for the capability
• For each module in a capability, determine the subset of entities.
  • Write the initial additional text for the module.
  • Review existing RDL for the entity for its applicability to the entity in the capability and if all is not applicable add only what's applicable to class of class for capability.
  • Create new RDL as required and include in class of class if necessary.
• For each entity in a module in a capability, determine subset of attributes required including their cardinality.
  • Write the initial additional text for the entity.
  • Review existing RDL for the attribute for its applicability to the attribute in the capability and if all is not applicable add only what's applicable to class of class for capability.
  • Create new RDL as required and include in class of class if necessary.
• Create the capability in DEXlib.
• Perform "DEX dependencies" check in DEXlib.
• Establish user guidance, instantiation diagrams and descriptive text.
• Establish test plans.
• Perform testing.
• Quality assurance, see separate check list...