DI-IPSC-81428A

Software Installation Plan (SIP)

The Software Installation Plan (SIP) documents the developer's plans for installing software at user sites, including preparations, user training, and conversion from existing systems.

Approval DateJanuary 10, 2000

AMSC NumberN7373

Preparing Activity—

Project Number—

OPRN/SPAWAR

DTIC Applicable—

GIDEP Applicable—

Limitation—

Applicable Forms—

Approval Limitation—

Form Version—

DID Formatdd_form_1664

963C CompliantNo

DISTRIBUTION STATEMENT A: Approved for public release; distribution is unlimited.

Supersedes

DI-IPSC-81428

—

Description & Purpose

—

Application & Interrelationship

—

Use & Relationship

The Software Installation Plan (SIP) is a plan for installing software at user sites, including preparations, user training, and conversion from existing systems.

The SIP is developed when the developer will be involved in the installation of software at user sites and when the installation process will be sufficiently complex to require a documented plan. For software embedded in a hardware-software system, a fielding or deployment plan for the hardware-software system may make a separate SIP unnecessary.

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 develop and record plans for performing software installation and training at user sites.

This DID supersedes DI-IPSC-81428.

Preparation Instructions

1Reference documents.None.

2General instructions.

2.1Automated techniques.Use of automated techniques is encouraged. The term "document" in this DID means a collection of data regardless of its medium.

2.2Alternate presentation styles.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.

3Format.Following are the format requirements. The plan shall be in contractor format unless otherwise specified on the Contract Data Requirements List (CDRL)(DD 1423). The 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.

4Content.The plan shall contain the following: The numbers shown designate the paragraph numbers to be used in the document.

4.1Title page or identifier.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 system, subsystem, or item 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; and distribution statement. For data in a database or other alternative form, this information shall be included on external and internal labels or by equivalent identification methods.

4.2Table of contents.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.

4.3Page numbering/labeling.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.

4.4Response to tailoring instructions.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.

4.5Multiple paragraphs and subparagraphs.Any section, paragraph, or subparagraph in this DID may be written as multiple paragraphs or subparagraphs to enhance readability.

4.6Standard data descriptions.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.

4.7Substitution of existing documents.Commercial or other existing documents may be substituted for all or part of the document if they contain the required data.

4.8Scope.This section shall be divided into the following paragraphs.

4.8.1Identification.This paragraph shall contain a full identification of the system and the software to which this document applies, including, as applicable, identification number(s), title(s), abbreviation(s), version number(s), and release number(s).

4.8.2System overview.This paragraph shall briefly state the purpose of the system and the software to which this document applies. It shall describe the general nature of the system and software; summarize the history of system development, operation, and maintenance; identify the project sponsor, acquirer, user, developer, and support agencies; identify current and planned operating sites; and list other relevant documents.

4.8.3Document overview.This paragraph shall summarize the purpose and contents of this document and shall describe any security or privacy considerations associated with its use.

4.8.4Relationship to other plans.This paragraph shall describe the relationship, if any, of the SIP to other project management documents.

4.9Referenced documents.This section shall list the number, title, revision, and date of all documents referenced in this document. This section shall also identify the source for all documents not available through normal Government stocking activities.

4.10Installation overview.This section shall be divided into the following paragraphs to provide an overview of the installation process.

4.10.1Description.This paragraph shall provide a general description of the installation process to provide a frame of reference for the remainder of the document. A list of sites for software installation, the schedule dates, and the method of installation shall be included.

4.10.2Contact point.This paragraph shall provide the organizational name, office symbol/code, and telephone number of a point of contact for questions relating to this installation.

4.10.3Support materials.This paragraph shall list the type, source, and quantity of support materials needed for the installation. Included shall be terms such as magnetic tapes, disk packs, computer printer paper, and special forms.

4.10.4Training.This paragraph shall describe the developer's plans for training personnel who will operate and/or use the software installed at user sites. Included shall be the delineation between general orientation, classroom training, and "hands-on" training.

4.10.5Tasks.This paragraph shall list and describe in general terms each task involved in the software installation. Each task description shall identify the organization but will accomplish the task, usually either the user, computer operations, or the developer. The task list shall include such items as:

4.10.5.1Providing overall planning, coordination, and preparation for installation

4.10.5.2Providing personnel for the installation team

4.10.5.3Arranging lodging, transportation, and office facilities for the installation team

4.10.5.4Ensuring that all manuals applicable to the installation are available when needed

4.10.5.5Ensuring that all other prerequisites have been fulfilled prior to the installation

4.10.5.6Planning and conducting training activities

4.10.5.7Providing students for the training

4.10.5.8Providing computer support and technical assistance for the installation.

4.10.5.9Providing for conversion from the current system.

4.10.6Personnel.This paragraph shall describe the number, type, and skill level of the personnel needed during the installation period, including the need for multishift operation, clerical support, etc.

4.10.7Security and privacy.This paragraph shall contain an overview of the security and privacy considerations associated with the system.

4.11Site-specific information for software center operations staff.This section applies if the software will be installed in computer center(s) or other centralized or networked software installations for users to access via terminals or using batch inputs/outputs. If this type of installation does not apply, this section shall contain the words "Not applicable."

4.11.1(Site-name).This paragraph shall identify a site or set of sites and shall be divided into the following subparagraphs to discuss those sites. Multiple sites may be discussed together when the information for those sites is generally the same.

4.11.1.1Schedule.This paragraph shall present a schedule of tasks to be accomplished during installation. It shall depict the tasks in chronological order with beginning and ending dates of each task and supporting narrative as necessary.

4.11.1.2Software inventory.This paragraph shall provide an inventory of the software needed to support the installation. The software shall be identified by name, identification number, version number, release number, configuration, and security classification, as applicable. This paragraph shall indicate whether the software is expected to be on site or will be delivered for the installation and shall identify any software to be used only to facilitate the installation process.

4.11.1.3Facilities.This paragraph shall detail the physical facilities and accommodations needed during the installation period. This description shall include the following, as applicable:

4.11.1.3.1Classroom, workspace, and training aids needed, specifying hours per day, number of days and shifts

4.11.1.3.2Hardware that must be operational and available

4.11.1.3.3Transportation and lodging for the installation team

4.11.1.4Installation team.This paragraph shall describe the composition of the installation team. Each team member's tasks shall be defined.

4.11.1.5Installation procedures.This paragraph shall provide step-by-step procedures for accomplishing the installation. References may be made to other documents, such as operator manuals. Safety precautions, marked by WARNING or CAUTION, shall be included where applicable. The procedures shall include the following, as applicable:

4.11.1.5.1Installing the software

4.11.1.5.2Checking out the software once installed

4.11.1.5.3Initializing databases and other software with site-specific data

4.11.1.5.4Conversion from the current system, possibly involving running in parallel

4.11.1.5.5Dry run of the procedures in operator and user manuals

4.11.1.6Data update procedures.This paragraph shall present the data update procedures to be followed during the installation period. When the data update procedures are the same as normal updating or processing procedures, reference may be made to other documents, such as operator manuals.

4.12Site-specific information for software users.This section shall provide installation planning pertinent to users of the software. When more than one type of user is involved, for example, users at different positions, performing different functions, or in different organizations, a separate section (Section 5 through n) may be written for each type of user and the section titles modified to reflect each user.

4.12.1(Site name).This paragraph shall identify a site or set of sites and shall be divided into the following subparagraphs to discuss those sites. Multiple sites may be discussed together when the information for those sites is generally the same.

4.12.1.1Schedule.This paragraph shall present a schedule of tasks to be accomplished by the user during installation. It shall depict the tasks in chronological order including beginning and ending dates for each task and supporting narrative as necessary.

4.12.1.2Installation procedures.This paragraph shall provide step-by-step procedures for accomplishing the installation. Reference may be made to other documents, such as user manuals. The procedures shall include the following, as applicable:

4.12.1.2.1Performing the tasks under 4.x.5 if not performed by operations staff

4.12.1.2.2Initializing user-specific data

4.12.1.2.3Setting up queries and other user inputs

4.12.1.2.4Performing sample processing

4.12.1.2.5Generating sample reports

4.12.1.2.6Conversion from the current system, possibly involving running in parallel

4.12.1.2.7Dry run of procedures in user manuals

4.12.1.3Data update procedures.This paragraph shall be divided into subparagraphs to present the user's data update procedures to be followed during the installation period. When update procedures are the same as normal processing, reference may be made to other documents, such as user manuals, and to Section 4 of this document.

4.13Notes.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 terms and definitions needed to understand this document. If section 5 has been expanded into section(s) 6,...n, this section shall be numbered as the next section following section n.

4.14Appendixes.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.).

References

—

Schema v3.0Community-maintained · Verify against ASSIST

Community-maintained — not an official government database.
Verify against ASSIST·GitHub·About·Disclaimer