The cartridge guides are delivered in PDF format and are based on a template. The topics in the guides include cartridge installation and testing, atomic action and service action commands, network element templates, and user defined exit types.
Design Studio provides a cartridge guide generation feature that simplifies this documentation process. The feature becomes available whenever you create an Activation Network Cartridge project.
The cartridge generation feature creates a cover, table of contents, chapters, sections, headings, standard text and variables. Also, the feature creates most of the cartridge documentation in the appropriate area of the template. Developers complete the guide by adding variables and placeholders to subsections (for example, for installation and testing).
The four main subtopics generated by the Design Studio Cartridge Guide feature are:
Cartridge Overview
Atomic Service Description Layer (ASDL) Commands
Service Definitions
Configuring ASAP to Support Additional NE Instances
Note:
The Cartridge Guide template is created as a starting point for documentation when creating an Activation Network Cartridge project, but can be replaced with another file if desired.