The CSDB (Common Source Data Base)
The CSDB is the glue that holds the modular information management system together. It stores all the information objects used to produce a project’s technical publications.
A good CSDB management tool should meet five objectives:
- Support the technical publication process through easy access and reuse
- Support controlled authoring
- Support quality assurance
- Support the exchange of data among partners, suppliers, and customers
- Support the delivery of technical publications in various formats on various media.
S1000D specifies the data structure of the information objects and the processes for a CSDB management tool. The choice of software for implementing it is not specified; the database could be as simple as a Windows directory structure or as complex as a collection of distributed databases.
Several different kinds of information objects may be stored in a CSDB:
- Illustrations and multimedia associated with a data module. These are the figures, videos, animations, 3-D objects, or audio files that can accompany and supplement the contents of a data module (see Content in the next section). (S1000D Chapter 3.9.2)
- Comments. Comments are a way for users to report on errors or to suggest improvements to a data module. These can be used either during the verification process or when the modules are in service. (S1000D Chapter 4.6)
- Publication module. This module is used to manage both the preparation and publication of an S1000D document. It has an identifier (the Publication Module Code (PMC)), a status section, and a content section. A publication module lists every one of the data modules (and any other appropriate publication modules or external legacy PDF publications) in the exact order in which the publication will deliver them to the user.
- Data dispatch notes (DDNs). A DDN describes the contents of a delivery package (e.g., change package). It lists all items (data modules, publication modules, illustrations, etc.) included in a particular data delivery. (S1000D Chapter 7.5)
- Data modules, which are discussed in detail on their own page.
For more information on CSDBs and how they are created, used, and organized, consider registering for one of our training courses.