- DATA ITEM DESCRIPTION
- 2. IDENTIFICATION NUMBER
- 3. DESCRIPTION/PURPOSE
- 7. APPLICATION/INTERRELATIONSHIP
- 10. PREPARATION INSTRUCTIONS
- 10.1 General instructions.
- 10.1.1 Automated techniques
- 10.1.2 Alternate presentation styles
- 10.1.3 Title page or identifier with signature blocks.
- 10.1.4 Table of contents.
- 10.1.5 Page numbering/labeling.
- 10.1.6 Response to tailoring instructions.
- 10.1.7 Multiple paragraphs and subparagraphs.
- 10.1.8 Standard data descriptions.
- 10.1.9 Substitution of existing documents.
- 10.2 Content requirements.
- 1 Scope.
- 3. Database-wide design decisions.
- 4 Detailed design of the database.
- 5 Detailed design of software units used for database access or manipulation.
- 6 Requirements traceability.
- 7 Notes.
- A. Appendixes.
- Copyright Holder Contact
The following establishes the data general and content requirements for the identified data item.
DATABASE DESIGN DESCRIPTION (DBDD)
The Database Design Description (DBDD) describes the design of a database, that is, a collection of related data stored in one or more computerized files in a manner that can be accessed by users or computer programs via a database management system (DBMS). It can also describe the software units used to access or manipulate the data.
The DBDD is used as the basis for implementing the database and related software units. It provides the acquirer visibility into the design and provides information needed for software support.
This Data Item Description (DID) contains the format and content preparation instructions for the data product generated by specific and discrete task requirements as delineated in the contract.
This DID is used when the developer is tasked to define and record the design of one or more databases.
Software units that access or manipulate the database may be described here or in Software Design Descriptions (SDDs) (DI-IPSC-81435). Interfaces may be described here or in Interface Design Descriptions (IDDs) (DI-IPSC-81436).
The Contract Data Requirements List (CDRL) should specify whether deliverable data are to be delivered on paper or electronic media; are to be in a given electronic form (such as ASCII, CALS, or compatible with a specified word processor or other support software); may be delivered in developer format rather than in the format specified herein; and may reside in a computer-aided software engineering (CASE) or other automated tool rather than in the form of a traditional document.
This DID supersedes DI-IPSC-80692 and DI-MCCR-80305.
Use of automated techniques is encouraged. The term 'document' in this DID means a collection of data regardless of its medium.
Diagrams, tables, matrices, and other presentation styles are acceptable substitutes for text when data required by this DID can be made more readable using these styles.
The document shall include a title page containing, as applicable: document number; volume number; version/revision indicator; security markings or other restrictions on the handling of the document; date; document title; name, abbreviation, and any other identifier for the systems, subsystems, or items to which the document applies; contract number; CDRL item number; organization for which the document has been prepared; name and address of the preparing organization; distribution statement; and signature blocks for the developer representative authorized to release the document, the acquirer representative authorized to approve the document, and the dates of release/approval. For data in a database or other alternative form, this information shall be included on external and internal labels or by equivalent identification methods.
The document shall contain a table of contents providing the number, title, and page number of each titled paragraph, figure, table, and appendix. For data in a database or other alternative form, this information shall consist of an internal or external table of contents containing pointers to, or instructions for accessing, each paragraph, figure, table, and appendix or their equivalents.
Each page shall contain a unique page number and display the document number, including version, volume, and date, as applicable. For data in a database or other alternative form, files, screens, or other entities shall be assigned names or numbers in such a way that desired data can be indexed and accessed.
If a paragraph is tailored out of this DID, the resulting document shall contain the corresponding paragraph number and title, followed by 'This paragraph has been tailored out.' For data in a database or other alternative form, this representation need occur only in the table of contents or equivalent.
Any section, paragraph, or subparagraph in this DID may be written as multiple paragraphs or subparagraphs to enhance readability.
If a data description required by this DID has been published in a standard data element dictionary specified in the contract, reference to an entry in that dictionary is preferred over including the description itself.
Commercial or other existing documents may be substituted for all or part of the document if they contain the required data.
Content requirements begin on the following page. The numbers shown designate the paragraph numbers to be used in the document. Each such number is understood to have the prefix '10.2' within this DID. For example, the paragraph numbered 1.1 is understood to be paragraph 10.2.1.1 within this DID.
This section shall be divided into the following paragraphs.
This paragraph shall contain a full identification of the database to which this document applies, including, as applicable, identification number(s), title(s), abbreviation(s), version number(s), and release number(s).
This paragraph shall briefly state the purpose of the database to which this document applies. It shall describe the general nature of the database; summarize the history of its development, use, and maintenance; identify the project sponsor, acquirer, user, developer, and support agencies; identify current and planned operating sites; and list other relevant documents.
This paragraph shall summarize the purpose and contents of this document and shall describe any security or privacy considerations associated with its use.
This section shall list the number, title, revision, and date of all documents referenced in this manual. This section shall also identify the source for all documents not available through normal Government stocking activities.
This section shall be divided into paragraphs as needed to present database-wide design decisions, that is, decisions about the database's behavioral design (how it will behave, from a user's point of view, in meeting its requirements, ignoring internal implementation) and other decisions affecting further design of the database. If all such decisions are explicit in the system or CSCI requirements, this section shall so state. Design decisions that respond to requirements designated critical, such as those for safety, security, or privacy, shall be placed in separate subparagraphs. If a design decision depends upon system states or modes, this dependency shall be indicated. If some or all of the design decisions are described in the documentation of a custom or commercial database management system (DBMS), they may be referenced from this section. Design conventions needed to understand the design shall be presented or referenced. Examples of database-wide design decisions are the following:
Design decisions regarding queries or other inputs the database will accept and outputs (displays, reports, messages, responses, etc.) it will produce, including interfaces with other systems, HWCIs, CSCIs, and users (5.x.d of this DID identifies topics to be considered in this description). If part or all of this information is given in Interface Design Descriptions (IDDs), they may be referenced.
Design decisions on database behavior in response to each input or query, including actions, response times and other performance characteristics, selected equations/algorithms/rules, disposition, and handling of unallowed inputs
Design decisions on how databases/data files will appear to the user (4.x of this DID identifies topics to be considered in this description)
Design decisions on the database management system to be used (including name, version/release) and the type of flexibility to be built into the database for adapting to changing requirements
Design decisions on the levels and types of availability, security, privacy, and continuity of operations to be offered by the database
Design decisions on database distribution (such as client/server), master database file updates and maintenance, including maintaining consistency, establishing/ reestablishing and maintaining synchronization, enforcing integrity and business rules
Design decisions on backup and restoration including data and process distribution strategies, permissible actions during backup and restoration, and special considerations for new or non-standard technologies such as video and sound
Design decisions on repacking, sorting, indexing, synchronization, and consistency including automated disk management and space reclamation considerations, optimizing strategies and considerations, storage and size considerations, and population of the database and capture of legacy data.
This section shall be divided into paragraphs as needed to describe the detailed design of the database. The number of levels of design and the names of those levels shall be based on the design methodology used. Examples of database design levels include conceptual, internal, logical, and physical. If part or all of the design depends upon system states or modes, this dependency shall be indicated. Design conventions needed to understand the design shall be presented or referenced. Note: This DID uses the term 'data element assembly' to mean any entity, relation, schema, field, table, array, etc., that has structure (number/order/grouping of data elements) at a given design level (e.g., conceptual, internal, logical, physical) and the term 'data element' to mean any relation, attribute, field, cell, data element, etc. that does not have structure at that level.
This paragraph shall identify a database design level and shall describe the data elements and data element assemblies of the database in the terminology of the selected design method. The information shall include the following, as applicable, presented in any order suited to the information to be provided:
Characteristics of individual data elements in the database design, such as:
Non-technical (natural-language) name
DoD standard data element name
Technical name (e.g., field name in the database)
Abbreviation or synonymous names
Data type (alphanumeric, integer, etc.)
Size and format (such as length and punctuation of a character string)
Units of measurement (such as meters, dollars, nanoseconds)
Range or enumeration of possible values (such as 0-99)
Accuracy (how correct) and precision (number of significant digits)
Priority, timing, frequency, volume, sequencing, and other constraints, such as whether the data element may be updated and whether business rules apply
Security and privacy constraints
Sources (setting/sending entities) and recipients (using/receiving entities)
Characteristics of data element assemblies (records, messages, files, arrays, displays, reports, etc.) in the database design, such as:
Non-technical (natural language) name
Technical name (e.g., record or data structure name in code or database)
Abbreviations or synonymous names
Data elements in the assembly and their structure (number, order, grouping)
Medium (such as disk) and structure of data elements/assemblies on the medium
Visual and auditory characteristics of displays and other outputs (such as colors, layouts, fonts, icons and other display elements, beeps, lights)
Relationships among assemblies, such as sorting/access characteristics
Priority, timing, frequency, volume, sequencing, and other constraints, such as whether the assembly may be updated and whether business rules apply
Security and privacy constraints
Sources (setting/sending entities) and recipients (using/receiving entities)
This section shall be divided into the following paragraphs to describe each software unit used for database access or manipulation. If part or all of this information is provided elsewhere, such as in a Software Design Description (SDD), the SDD for a customized DBMS, or the user manual of a commercial DBMS, that information may be referenced rather than repeated here. If part or all of the design depends upon system states or modes, this dependency shall be indicated. If design information falls into more than one paragraph, it may be presented once and referenced from the other paragraphs. Design conventions needed to understand the design shall be presented or referenced.
This paragraph shall identify a software unit by project-unique identifier and shall describe the unit. The description shall include the following information, as applicable. Alternatively, this paragraph may designate a group of software units and identify and describe the software units in subparagraphs. Software units that contain other software units may reference the descriptions of those units rather than repeating information.
Unit design decisions, if any, such as algorithms to be used, if not previously selected
Any constraints, limitations, or unusual features in the design of the software unit
The programming language to be used and rationale for its use if other than the specified CSCI language
If the software unit consists of or contains procedural commands (such as menu selections in a database management system (DBMS) for defining forms and reports, on-line DBMS queries for database access and manipulation, input to a graphical user interface (GUI) builder for automated code generation, commands to the operating system, or shell scripts), a list of the procedural commands and a reference to user manuals or other documents that explain them
If the software unit contains, receives, or outputs data, a description of its inputs, outputs, and other data elements and data element assemblies, as applicable. Data local to the software unit shall be described separately from data input to or output from the software unit. Interface characteristics may be provided here or by referencing Interface Design Description(s). If a given interfacing entity is not covered by this DBDD (for example, an external system) but its interface characteristics need to be mentioned to describe software units that are, these characteristics shall be stated as assumptions or as 'When [the entity not covered] does this, [the software unit] will....' This paragraph may reference other documents (such as data dictionaries, standards for protocols, and standards for user interfaces) in place of stating the information here. The design description shall include the following, as applicable, presented in any order suited to the information to be provided, and shall note any differences in these characteristics from the point of view of the interfacing entities (such as different expectations about the size, frequency, or other characteristics of data elements):
Project-unique identifier for the interface
Identification of the interfacing entities (software units, configuration items, users, etc.) by name, number, version, and documentation references, as applicable
Priority assigned to the interface by the interfacing entity(ies)
Type of interface (such as real-time data transfer, storage-and-retrieval of data, etc.) to be implemented
Characteristics of individual data elements that the interfacing entity(ies) will provide, store, send, access, receive, etc. Paragraph 4.x.a of this DID identifies topics to be covered in this description.
Characteristics of data element assemblies (records, messages, files, arrays, displays, reports, etc.) that the interfacing entity(ies) will provide, store, send, access, receive, etc. Paragraph 4.x.b of this DID identifies topics to be covered in this description.
Characteristics of communication methods that the interfacing entity(ies) will use for the interface, such as:
Communication links/bands/frequencies/media and their characteristics
Flow control (such as sequence numbering and buffer allocation)
Data transfer rate, whether periodic/aperiodic, and interval between transfers
Routing, addressing, and naming conventions
Transmission services, including priority and grade
Safety/security/privacy considerations, such as encryption, user authentication, compartmentalization, and auditing
Characteristics of protocols that the interfacing entity(ies) will use for the interface, such as:
Priority/layer of the protocol
Packeting, including fragmentation and reassembly, routing, and addressing
Legality checks, error control, and recovery procedures
Synchronization, including connection establishment, maintenance, termination
Status, identification, and any other reporting features
Other characteristics, such as physical compatibility of the interfacing entity(ies) (dimensions, tolerances, loads, voltages, plug compatibility, etc.)
If the software unit contains logic, the logic to be used by the software unit, including, as applicable:
Conditions in effect within the software unit when its execution is initiated
Conditions under which control is passed to other software units
Response and response time to each input, including data conversion, renaming, and data transfer operations
Sequence of operations and dynamically controlled sequencing during the software unit's operation, including:
The method for sequence control
The logic and input conditions of that method, such as timing variations, priority assignments
Data transfer in and out of memory
The sensing of discrete input signals, and timing relationships between interrupt operations within the software unit
Exception and error handling
This section shall contain:
Traceability from each database or other software unit covered by this DBDD to the system or CSCI requirements it addresses. =item 2
Traceability from each system or CSCI requirement that has been allocated to a database or other software unit covered in this DBDD to the database or other software units that address it.
This section shall contain any general information that aids in understanding this document (e.g., background information, glossary, rationale). This section shall include an alphabetical listing of all acronyms, abbreviations, and their meanings as used in this document and a list of any terms and definitions needed to understand this document.
Appendixes may be used to provide information published separately for convenience in document maintenance (e.g., charts, classified data). As applicable, each appendix shall be referenced in the main body of the document where the data would normally have been provided. Appendixes may be bound as separate documents for ease in handling. Appendixes shall be lettered alphabetically (A, B, etc.).
This Perl Plain Old Documentation (POD) version is copyright © 2001 2003 Software Diamonds. This POD version was derived from the hard copy public domain version freely distributed by the United States Federal Government.
Software Diamonds permits the redistribution and use in source and binary forms, with or without modification, provided that the following conditions are met:
Redistributions of source code, modified or unmodified must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
SOFTWARE DIAMONDS, http://www.SoftwareDiamonds.com, PROVIDES THIS SOFTWARE 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SOFTWARE DIAMONDS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING USE OF THIS SOFTWARE, EVEN IF ADVISED OF NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE POSSIBILITY OF SUCH DAMAGE.
1 POD Error
The following errors were encountered while parsing the POD:
- Around line 763:
Non-ASCII character seen before =encoding in '©'. Assuming ISO8859-1