2 - Data Requirements.pdf

For the best experience, open this PDF portfolio in

Acrobat X or Adobe Reader X, or later.

Get Adobe Reader Now!

http://www.adobe.com/go/reader

DD FORM 1423-1, FEB 2001

CONTRACT DATA REQUIREMENTS LIST

(1 Data Item)

PREVIOUS EDITION MAY BE USED.

Form Approved OMB No. 0704-0188

The public reporting burden for this collection of information is estimated to average 110 hours per response, including the time for reviewing instructions, searching existing data sources, gathering and maintaining the data needed, and completing and reviewing the collection of information. Send comments regarding this burden estimate or any other aspect of this collection of information, including suggestions for reducing the burden, to the Department of Defense, Executive Services and Communications Directorate (0704-0188). Respondents should be aware that notwithstanding any other provision of law, no person shall be subject to any penalty for failing to comply with a collection of information if it does not display a currently valid OMB control number. Please do not return your form to the above organization. Send completed form to the Government Issuing Contracting Officer for the Contract/PR No. listed in Block E.

A. CONTRACT LINE ITEM NO. B. EXHIBIT C. CATEGORY:

TDP ________ TM _______ OTHER

D. SYSTEM/ITEM E. CONTRACT/PR NO. F. CONTRACTOR

1. DATA ITEM NO. 2. TITLE OF DATA ITEM 3. SUBTITLE

4. AUTHORITY (Data Acquisition Document No.) 5. CONTRACT REFERENCE 6. REQUIRING OFFICE

7. DD 250 REQ

8. APP CODE

9. DIST STATEMENT

REQUIRED

10. FREQUENCY

11. AS OF DATE

12. DATE OF FIRST SUBMISSION

13. DATE OF SUBSEQUENT

SUBMISSION

14. DISTRIBUTION

a. ADDRESSEE

b. COPIES

Draft Final

Reg Repro

15. TOTAL

16. REMARKS

17. PRICE GROUP

18. ESTIMATED

TOTAL PRICE

G. PREPARED BY H. DATE I. APPROVED BY J. DATE

Page of Pages

1403209658C

Cross-Out

1_DATA_ITEM_NO: A001

2_TITLE_OF_DATA_ITEM: Commercial-Off-The-Shelf (COTS) Manual

3_SUBTITLE:

4_AUTHORITY_Data_Acquisit: DI-TMSS-80527D

5_CONTRACT_REFERENCE: PD 24E-055AB-RF

6_REQUIRING_OFFICE: AFLCMC/WNME

7_DID_250_REQ: N/A

8_APP_CODE: N/A

DIST_STATEMENT: D

10_FREQUENCY: ASREQ

11_AS_OF_DATE: ASREQ

12_DATE_OF_FIRST_SUBMISSI: See BLK 16

13_DATE_OF_SUBSEQUENT_SUB: See BLK 16 addressee1:

draft1:

reg1:

repro1:

addressee2: 1. AFMETCAL draft2:

reg2:

repro2:

addressee3: Attn: Mike Hickey draft3:

reg3: 1 repro3:

addressee4: 813 Irving-Wick Drive W Horton Bldg draft4:

reg4:

repro4:

addressee5: Heath, Ohio 43056 draft5:

reg5:

repro5:

addressee6:

draft6:

reg6:

repro6:

addressee7:

draft7:

reg7:

repro7:

addressee8:

draft8:

reg8:

repro8:

addressee9: Ship with unit draft9:

reg9: 1 repro9:

addressee10:

draft10:

reg10:

repro10:

addressee11:

draft11:

reg11:

repro11:

addressee12:

draft12:

reg12:

repro12:

addressee13:

draft13:

reg13:

repro13:

addressee14:

draft14:

reg14:

repro14:

addressee15:

draft15:

reg15:

repro15:

addressee16:

draft16:

reg16:

repro16:

addressee17:

draft17:

reg17:

repro17:

addressee18:

draft18:

reg18:

repro18:

addressee19:

draft19:

reg19:

repro19:

addressee20:

draft20:

reg20:

repro20:

addressee21:

draft21:

reg21:

repro21:

addressee22:

draft22:

reg22:

repro22:

addressee23:

draft23:

reg23:

repro23:

addressee24:

draft24:

reg24:

repro24:

addressee25:

draft25:

reg25:

repro25:

addressee26:

draft26:

reg26:

repro26:

addressee27:

draft27:

reg27:

repro27:

addressee28:

draft28:

reg28:

repro28:

addressee29:

draft29:

reg29:

repro29:

addressee30:

draft30:

reg30:

repro30:

addressee31:

draft31:

reg31:

repro31:

addressee32:

draft32:

reg32:

repro32:

addressee33:

draft33:

reg33:

repro33:

addressee34:

draft34:

reg34:

repro34:

addressee35:

draft35:

reg35:

repro35:

addressee36:

draft36:

reg36:

repro36:

addressee37:

draft37:

reg37:

repro37:

addressee38:

draft38:

reg38x:

repro38:

total_draft: 0 total_repro: 0

16_REMARKS: Blk 12: No later than 60 days after contract award, 1 copy(ies) of the final manual is(are) required on CD/DVD in indexed Portable Document Format (iPDF). Ship to addressee #1 listed in BLK 14a. If manuals are available electronically, the file or web link may be sent to michael.hickey.2@us.af.mil. Reference contract number in all correspondence.

Blk 13: Concurrent with delivery of production unit(s) contractor shall furnish and pack 1 set of the manuals with each unit. Manual shall be on CD/DVD in indexed Portable Document Format (iPDF). Ship with unit.

17_PRICE_GROUP:

ESTIMATED_TOTAL_PRICE:

G_PREPARED_BY:

H_DATE: 1/17/24

1_APPROVED_BY:

J_DATE: 1/17/24

Page: 1 reg38t: 2

A_CONTRACT_LINE_ITEM_NO:

B_EXHIBIT: A(FY 24)

TDP:

TM: x

OTHER:

DSYSTEMITEM: 50 GHz VNA

E_CONTRACTPR_NO:

FCONTRACTOR:

of_pages: 4

Reset:

2024-01-17T08:44:17-0500

MORETTI.MEGAN.ANN.1623937085

2024-01-17T09:09:52-0500

LONG.GEORGE.ALLAN.1271080758

DD FORM 1423-2, AUG 96

(2 Data Items)

The public reporting burden for this collection of information is estimated to average 220 hours per response, including the time for reviewing instructions, searching existing data sources, gathering and maintaining the data needed, and completing and reviewing the collection of information. Send comments regarding this burden estimate or any other aspect of this collection of information, including suggestions for reducing the burden, to the Department of Defense, Executive Services and Communications Directorate (0704-0188). Respondents should be aware that notwithstanding any other provision of law, no person shall be subject to any penalty for failing to comply with a collection of information if it does not display a currently valid OMB control number. Please do not return your form to the above organization. Send completed form to the

TDP ________ TM _______ OTHER _________________________

11. AS OF DATE 13. DATE OF SUBSEQUENT

12. DATE OF FIRST SUBMISSION 14. DISTRIBUTION

Page ____ of ____ Pages

A_CONTRACT_LINE_ITEM_NO:

B_EXHIBIT: A (FY 24)

TDP: Off

TIM: Yes

OTHER:

D_SYSTEMITEM: 50 GHz VNA

E_CONTRACTPR_NO:

FCONTRACTOR:

1_DATA_ITEM_NO1: A002

2_TITLE_OF_DATA_ITEM1: Calibration Certification

3_SUBTITLE1:

4_AUTHORITY1: DI-QCIC-80798C

5_CONTRACT_REFERENCE1: PD 24E-055AB-RF

6_REQUIRING_OFFICE1: AFLCMC/WNME

7_DD_250_REQ1: N/A

8_APP_CODE1: N/A

9_dist1: D

10_FREQUENCY1: ASREQ

11_AS_OF_DATE1: ASREQ

12_DATE_OF_FIRST_SUB1: See BLK 16

13_DATE_OF_SUBSEQUENT_SUB1: See BLK 16 addr1_1:

draft1_1:

reg1_1:

repro1_1:

1_DATA_ITEM_NO2: A003

2_TITLE_OF_DATA_ITEM2: Software User Manual

3_SUBTITLE2:

4_AUTHORITY2: DI-IPSC-81443A

5_CONTRACT_REFERENCE2: PD 24E-055AB-RF

6_REQUIRING_OFFICE2: AFLCMC/WNME

7_DD_250_REQ2: N/A

8_APP_CODE2: N/A

9_dist2: D

10_FREQUENCY2: ASREQ

11_AS_OF_DATE2: ASREQ

12_DATE_OF_FIRST_SUB2: See BLK 16

13_DATE_OF_SUBSEQUENT_SUB2: See BLK 16 addr2_1:

draft2_1:

reg2_1:

repro2_1:

addr1_2: Ship with unit draft1_2:

reg1_2: 1 repro1_2:

addr1_3:

draft1_3:

reg1_3:

repro1_3:

addr1_4:

draft1_4:

reg1_4:

repro1_4:

addr1_5:

draft1_5:

reg1_5:

repro1_5:

addr1_6:

draft1_6:

reg1_6:

repro1_6:

addr1_7:

draft1_7:

reg1_7:

repro1_7:

addr1_8:

draft1_8:

reg1_8:

repro1_8:

addr1_9:

draft1_9:

reg1_9:

repro1_9:

addr1_10:

draft1_10:

reg1_10:

repro1_10:

addr1_11:

draft1_11:

reg1_11:

repro1_11:

addr1_12:

draft1_12:

reg1_12:

repro1_12:

addr1_13:

draft1_13:

reg1_13:

repro1_13:

addr1_14:

draft1_14:

reg1_14:

repro1_14:

15_total_Draft1: 0

15_TOTALReg1: 1

15_TOTALRepro1: 0

16_REMARKS1:

BLK 12: Concurrent with delivery of production unit(s), the contractor shall furnish and pack one (1) calibration certificate. Ship with unit.

17_PRICE_GROUP1:

18_totalprice1:

addr2_2: Ship with unit addr2_3:

addr2_4:

16_REMARKS2: BLK 12: Concurrent with delivery of production unit, the contractor shall furnish and pack one (1) software user manual with each unit. Ship with unit.

17_PRICE_GROUP2:

18_totalprice2:

addr2_5:

addr2_6:

addr2_7:

addr2_8:

addr2_9:

addr2_10:

addr2_11:

addr2_12:

addr2_13:

addr2_14:

draft2_2:

reg2_2: 1 repro2_2:

draft2_3:

reg2_3:

repro2_3:

draft2_4:

reg2_4:

repro2_4:

draft2_5:

reg2_5:

repro2_5:

draft2_6:

reg2_6:

repro2_6:

draft2_7:

reg2_7:

repro2_7:

draft2_8:

reg2_8:

repro2_8:

draft2_9:

reg2_9:

repro2_9:

draft2_10:

reg2_10:

repro2_10:

draft2_11:

reg2_11:

repro2_11:

draft2_12:

reg2_12:

repro2_12:

draft2_13:

reg2_13:

repro2_13:

draft2_14:

reg2_14:

repro2_14:

15_total_Draft2: 0

15_TOTALReg2: 1

15_TOTALRepro2: 0

G_PREPARED_BY:

H_DATE: 1/17/24

1_APPROVED_BY:

J_DATE: 1/17/24

Page: 2 of_pages: 4

Reset:

2024-01-17T08:45:05-0500

MORETTI.MEGAN.ANN.1623937085

2024-01-17T09:10:12-0500

LONG.GEORGE.ALLAN.1271080758

The public reporting burden for this collection of information is estimated to average 110 hours per response, including the time for reviewing instructions, searching existing data sources, gathering and maintaining the data needed, and completing and reviewing the collection of information. Send comments regarding this burden estimate or any other aspect of this collection of information, including suggestions for reducing the burden, to the Department of Defense, Executive Services and Communications Directorate (0704-0188). Respondents should be aware that notwithstanding any other provision of law, no person shall be subject to any penalty for failing to comply with a collection of information if it does not display a currently valid OMB control number. Please do not return your form to the above organization. Send completed form to the

1_DATA_ITEM_NO: B001

2_TITLE_OF_DATA_ITEM: Commercial-Off-The-Shelf (COTS) Manual

3_SUBTITLE:

4_AUTHORITY_Data_Acquisit: DI-TMSS-80527D

5_CONTRACT_REFERENCE: PD 24E-055AB-RF

6_REQUIRING_OFFICE: AFLCMC/WNME

7_DID_250_REQ: N/A

8_APP_CODE: N/A

DIST_STATEMENT: D

10_FREQUENCY: ASREQ

11_AS_OF_DATE: ASREQ

12_DATE_OF_FIRST_SUBMISSI: See BLK 16

13_DATE_OF_SUBSEQUENT_SUB: See BLK 16 addressee1:

draft1:

reg1:

repro1:

addressee2: 1. AFMETCAL draft2:

reg2:

repro2:

addressee3: Attn: Mike Hickey draft3:

reg3: 1 repro3:

addressee4: 813 Irving-Wick Drive W Horton Bldg draft4:

reg4:

repro4:

addressee5: Heath, Ohio 43056 draft5:

reg5:

repro5:

addressee6:

draft6:

reg6:

repro6:

addressee7:

draft7:

reg7:

repro7:

addressee8:

draft8:

reg8:

repro8:

addressee9: Ship with unit draft9:

reg9: 6 repro9:

addressee10:

draft10:

reg10:

repro10:

addressee11:

draft11:

reg11:

repro11:

addressee12:

draft12:

reg12:

repro12:

addressee13:

draft13:

reg13:

repro13:

addressee14:

draft14:

reg14:

repro14:

addressee15:

draft15:

reg15:

repro15:

addressee16:

draft16:

reg16:

repro16:

addressee17:

draft17:

reg17:

repro17:

addressee18:

draft18:

reg18:

repro18:

addressee19:

draft19:

reg19:

repro19:

addressee20:

draft20:

reg20:

repro20:

addressee21:

draft21:

reg21:

repro21:

addressee22:

draft22:

reg22:

repro22:

addressee23:

draft23:

reg23:

repro23:

addressee24:

draft24:

reg24:

repro24:

addressee25:

draft25:

reg25:

repro25:

addressee26:

draft26:

reg26:

repro26:

addressee27:

draft27:

reg27:

repro27:

addressee28:

draft28:

reg28:

repro28:

addressee29:

draft29:

reg29:

repro29:

addressee30:

draft30:

reg30:

repro30:

addressee31:

draft31:

reg31:

repro31:

addressee32:

draft32:

reg32:

repro32:

addressee33:

draft33:

reg33:

repro33:

addressee34:

draft34:

reg34:

repro34:

addressee35:

draft35:

reg35:

repro35:

addressee36:

draft36:

reg36:

repro36:

addressee37:

draft37:

reg37:

repro37:

addressee38:

draft38:

reg38x:

repro38:

total_draft: 0 total_repro: 0

16_REMARKS: Blk 12: No later than 90 days after acceptance of the AFPSL unit, 1 copy(ies) of the final manual is(are) required on CD/DVD in indexed Portable Document Format (iPDF). Ship to addressee #1 listed in BLK 14a. If manuals are available electronically, the file or web link may be sent to michael.hickey.2@us.af.mil. Reference contract number in all correspondence.

Blk 13: Concurrent with delivery of production unit(s) contractor shall furnish and pack 1 set of the manuals with each unit. Manual shall be on CD/DVD in indexed Portable Document Format (iPDF). Ship with unit.

17_PRICE_GROUP:

ESTIMATED_TOTAL_PRICE:

G_PREPARED_BY:

H_DATE: 1/17/24

1_APPROVED_BY:

J_DATE: 1/17/24

Page: 3 reg38t: 7

A_CONTRACT_LINE_ITEM_NO:

B_EXHIBIT: B(FY 24-27)

TDP:

TM: x

OTHER:

DSYSTEMITEM: 50 GHz VNA

E_CONTRACTPR_NO:

FCONTRACTOR:

of_pages: 4

Reset:

2024-01-17T08:45:29-0500

MORETTI.MEGAN.ANN.1623937085

2024-01-17T09:10:21-0500

LONG.GEORGE.ALLAN.1271080758

The public reporting burden for this collection of information is estimated to average 110 hours per response, including the time for reviewing instructions, searching existing data sources, gathering and maintaining the data needed, and completing and reviewing the collection of information. Send comments regarding this burden estimate or any other aspect of this collection of information, including suggestions for reducing the burden, to the Department of Defense, Executive Services and Communications Directorate (0704-0188). Respondents should be aware that notwithstanding any other provision of law, no person shall be subject to any penalty for failing to comply with a collection of information if it does not display a currently valid OMB control number. Please do not return your form to the above organization. Send completed form to the

1_DATA_ITEM_NO: B002

2_TITLE_OF_DATA_ITEM: Calibration Certificate

3_SUBTITLE:

4_AUTHORITY_Data_Acquisit: DI-QCIC-80798C

5_CONTRACT_REFERENCE: PD 24E-055AB-RF

6_REQUIRING_OFFICE: AFLCMC/WNME

7_DID_250_REQ: N/A

8_APP_CODE: N/A

DIST_STATEMENT: D

10_FREQUENCY: ASREQ

11_AS_OF_DATE: ASREQ

12_DATE_OF_FIRST_SUBMISSI: See BLK 16

13_DATE_OF_SUBSEQUENT_SUB: See BLK 16 addressee1:

draft1:

reg1:

repro1:

addressee2:

draft2:

reg2:

repro2:

addressee3: Ship with unit draft3:

reg3: 1 repro3:

addressee4:

draft4:

reg4:

repro4:

addressee5:

draft5:

reg5:

repro5:

addressee6:

draft6:

reg6:

repro6:

addressee7:

draft7:

reg7:

repro7:

addressee8:

draft8:

reg8:

repro8:

addressee9:

draft9:

reg9:

repro9:

addressee10:

draft10:

reg10:

repro10:

addressee11:

draft11:

reg11:

repro11:

addressee12:

draft12:

reg12:

repro12:

addressee13:

draft13:

reg13:

repro13:

addressee14:

draft14:

reg14:

repro14:

addressee15:

draft15:

reg15:

repro15:

addressee16:

draft16:

reg16:

repro16:

addressee17:

draft17:

reg17:

repro17:

addressee18:

draft18:

reg18:

repro18:

addressee19:

draft19:

reg19:

repro19:

addressee20:

draft20:

reg20:

repro20:

addressee21:

draft21:

reg21:

repro21:

addressee22:

draft22:

reg22:

repro22:

addressee23:

draft23:

reg23:

repro23:

addressee24:

draft24:

reg24:

repro24:

addressee25:

draft25:

reg25:

repro25:

addressee26:

draft26:

reg26:

repro26:

addressee27:

draft27:

reg27:

repro27:

addressee28:

draft28:

reg28:

repro28:

addressee29:

draft29:

reg29:

repro29:

addressee30:

draft30:

reg30:

repro30:

addressee31:

draft31:

reg31:

repro31:

addressee32:

draft32:

reg32:

repro32:

addressee33:

draft33:

reg33:

repro33:

addressee34:

draft34:

reg34:

repro34:

addressee35:

draft35:

reg35:

repro35:

addressee36:

draft36:

reg36:

repro36:

addressee37:

draft37:

reg37:

repro37:

addressee38:

draft38:

reg38x:

repro38:

total_draft: 0 total_repro: 0

16_REMARKS: BLK 12: Concurrent with delivery of production unit(s), the contractor shall furnish and pack one (1) calibration certificate. Ship with unit.

17_PRICE_GROUP:

ESTIMATED_TOTAL_PRICE:

G_PREPARED_BY:

H_DATE: 1/17/24

1_APPROVED_BY:

J_DATE: 1/17/24

Page: 4 reg38t: 1

A_CONTRACT_LINE_ITEM_NO:

B_EXHIBIT: B(FY 24-27)

TDP:

TM: x

OTHER:

DSYSTEMITEM: 50 GHz VNA

E_CONTRACTPR_NO:

FCONTRACTOR:

of_pages: 4

Reset:

2024-01-17T08:45:53-0500

MORETTI.MEGAN.ANN.1623937085

2024-01-17T09:11:11-0500

LONG.GEORGE.ALLAN.1271080758

DATA ITEM DESCRIPTION

Title: COMMERCIAL OFF-THE-SHELF (COTS) MANUALS AND ASSOCIATED

SUPPLEMENTAL DATA

Approval Date: 20211203 Limitation: No GIDEP Applicable: No

Number: DI-TMSS-80527D AMSC Number: 10283 DTIC Applicable: No Office of Primary Responsibility: TM

Applicable Forms: None

Use/relationship: Commercial Off-the-Shelf Manuals may be used as-is or with supplementation to support COTS equipment used by DOD. This DID is used to:

a. Acquire sample COTS manuals for evaluation.

b. Acquire COTS manuals that have been evaluated and found to be acceptable.

c. Acquire associated supplemental data, if required.

This DID contains format, content, and intended use information for the data deliverable(s) resulting from the work described in MIL-PRF-32216.

This DID supersedes DI-TMSS-80527C, dated 12 Aug 2011.

Requirements:

1. Content. The manual shall contain all technical information on the assembly, installation, operation, parts, and maintenance of commercial equipment.

2. Evaluation. The manual shall be evaluated using the criteria found in MIL-PRF-32216.

3. Supplementation. The manual may be supplemented with additional data to comply with contract.

Supplemental data shall be prepared in accordance with MIL-PRF-32216.

4. Format. The basic manual shall be presented in the contractor's format. Supplemental data shall be presented in the format specified by the acquiring activity.

5. Digital files. Interactive Electronic Technical Manuals (IETMs) or PDFs are preferred for electronic COTS manuals.

6. PDF Files. PDF files shall be searchable, capable of having links added, and have fonts embedded.

7. IETMs. IETMs shall meet the general style and format and user interface requirements in MIL- STD-40051-1 (Army only) or MIL-STD-3031 (Army only).

8. Paper manuals. If paper manuals are acquired, the data shall be clearly legible and on paper of sufficient quality for long term use.

9. Quick Reference Guides (QRGs). QRGs shall meet the requirements of MIL-PRF-32614.

End of DI-TMSS-80527D

Source: http://assist.dla.mil -- Downloaded: 2022-10-28T11:42Z Check the source to verify that this is the current version before use.

Title: CALIBRATION CERTIFICATE/REPORT

Number: DI-QCIC-80798C Approved Date: 20170123 AMSC Number: F9766 Limitation: N/A DTIC Applicable: No GIDEP Applicable: No Preparing Activity: 36 Project Number: QCIC-2017-003 Applicable Forms: N/A Use/Relationship: The Calibration Certificate/Report documents calibration certificates or reports accompanying the calibrations performed on Department of Defense (DoD) test, measurement, and diagnostic equipment.

a. This Data Item Description (DID) contains the format and content preparation instructions for the data product generated by the specific and discrete task requirement as delineated in the contract.

b. This DID is applicable to contracts requiring calibration of test equipment prior to delivery.

This DID is consistent with ISO/IEC 17025, General requirements for the competence of testing and calibration laboratories, requirements for calibration reports or certificates.

(Copies of this document are available online at http://www.iso.org.)

c. This DID supersedes DI-QCIC-80798B.

1. Reference documents. The applicable issue of the documents cited herein, including their approval dates and dates of any applicable amendments, notices, and revisions, shall be as specified in the contract.

2. Format. Contractor format is acceptable.

3. Content. The calibration certificate or report shall include:

a. Title (e.g., calibration certificate or calibration report);

b. The name and address of the laboratory and the location where the calibrations were carried out, if different from the address of the laboratory;

c. Unique identification of the calibration certificate or test report (such as the serial number), and on each page an identification in order to ensure that the page is recognized as a part of the test report or calibration certificate, and a clear identification of the end of the calibration certificate or test report;

d. The name and address of the client or customer;

e. Identification of the method used;

f. A description of, the condition of, and the unambiguous identification of the item(s) tested or calibrated;

g. The date of receipt of the test or calibration item(s) where this is critical to the validity and application of the results, and the date(s) of performance of the test or calibration;

DISTRIBUTION STATEMENT A. Approved for public release. Distribution is unlimited.

DI-QCIC-80798C

h. Reference to the sampling plan and procedures used by the laboratory or other bodies where these are relevant to the validity or application of the results;

i. The test or calibration results with, where appropriate, the units of measurement;

j. The name(s), function(s) and signature(s) or equivalent identification of person(s) authorizing the calibration certificate or test report;

k. Where relevant, a statement to the effect that the results relate only to the items tested or calibrated;

l. The conditions (e.g., environmental) under which the calibrations were made that have an influence on the measurement results;

m. The uncertainty of measurement or a statement of compliance with an identified metrological specification or clauses thereof;

n. Evidence that the measurements are traceable.

End of DI-QCIC-80798C.

Title: SOFTWARE USER MANUAL (SUM)

Number: DI-IPSC-81443A AMSC Number: N7378 DTIC Applicable: No Office of Primary Responsibility: N/SPAW AR Applicable Forms: NIA

Use, Relationships:

Approval Date: 20000111 Limitation: N/ A GIDEP Applicable: No

The Software User Manual (SUM) tells a hands-on software user how to install and use a Computer Software Configuration Item (CSCI), a group of related CSCl's, or a software system or subsystem. It may also cover a particular aspect of software operation, such as instructions for a particular position or task.

The SUM is developed for software that is run by the user and has a user interface requiring on line user input or interpretation of displayed output. If the software is embedded in a hardware software system, user manuals or operating procedures for that system may make separate SUMs 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 identify and record information needed by hands-on users of software.

The SUM is an alternative to the Software Input/Output Manual (SIOM) (DI-IPSC-81445A) and Software Center Operator Manual (SCOM) (DI-IPSC-8 l 444A).

This DID supersedes DI-IPSC-81443.

1. Reference documents. None.

2. General instructions.

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

b. Alternate 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.

DI-IPSC-81443A

3. Format. Following are the format requirements.

The specification shall be in contractor format unless otherwise specified on the Contract Data Requirements List (CDRL)(DD 1423). The CORL 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.

4. Content. The specification shall contain the following:

a. Title 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.

b. Table of contents and index. The document shall contain a table of contents providing the number, title, and page number of each titled paragraph, figure, table, and appendix, and an index providing an alphabetic listing of key terms and concepts covered in the document and the pages or paragraphs in which the terms or concepts are covered. 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.

c. Page 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.

d. Response 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.

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

f. Standard 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 pref erred over including the description itself.

D1-IPSC-81443A

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

The numbers shown designate the paragraph numbers to be used in the document.

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

1.1 Identification. 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 ).

1.2 System 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.

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

2. Referenced 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.

3. Software summary. This section shall be divided into the following paragraphs.

3 .1 Software application. This paragraph shall provide a brief description of the intended uses of the software. Capabilities, operating improvements, and benefits expected from its use shall be described.

3.2 Software inventory. This paragraph shall identify all software files, including databases and data files, that must be installed for the software to operate. The identification shall include security and privacy considerations for each file and identification of the software necessary to continue or resume operation in case of an emergency.

3.3 Software environment. This paragraph shall identify the hardware, software, manual operations, and other resources needed for a user to install and run the software. Included, as applicable, shall be identification of:

a. Computer equipment that must be present, including amount of memory needed, amount of auxiliary storage needed, and peripheral equipment such as printers and other input/output devices

b. Communications equipment that must be present

c. Other software that must be present, such as operating systems, databases, data files, utilities, and other supporting systems

d. Forms, procedures, or other manual operations that must be present

e. Other facilities, equipment, or resources that must be present

3.4 Software organization and overview of operation. This paragraph shall provide a brief description of the organization and operation of the software from the user's point of view.

The description shall include, as applicable:

a. Logical components of the software, from the user's point of view, and an overview of the purpose/operation of each component

b. Performance characteristics that can be expected by the user, such as:

I) Types, volumes, rate of inputs accepted

2) Types, volume, accuracy, rate of outputs that the software can produce

3) Typical response time and factors that affect it

4) Typical processing time and factors that affect it

5) Limitations, such as number of events that can be tracked

6) Error rate that can be expected

7) Reliability that can be expected

c. Relationship of the functions performed by the software with interfacing systems, organizations, or positions

d. Supervisory controls that can be implemented (such as passwords) to manage the software

3. 5 Contingencies and alternate states and modes of operation. This paragraph shall explain differences in what the user will be able to do with the software at times of emergency and in various states and modes of operation, if applicable.

3.6 Security and privacy. This paragraph shall contain an overview of the security and privacy considerations associated with the software. A warning shall be included regarding making unauthorized copies of software or documents, if applicable.

3. 7 Assistance and problem reporting. This paragraph shall identify points of contact and procedures to be followed to obtain assistance and report problems encountered in using the software.

4. Access to the software. This section shall contain step-by-step procedures oriented to the first time/occasional user. Enough detail shall be presented so that the user can reliably access the software before learning the details of its functional capabilities. Safety precautions, marked by WARNING or. CAUTION, shall be included where applicable.

4.1 First-time user of the software. This paragraph shall be divided into the following subparagraphs.

4.1.1 Equipment familiarization. This paragraph shall describe the following as appropriate:

a. Procedures for turning on power and making adjustments

b. Dimensions and capabilities of the visual display screen

c. Appearance of the cursor, how to identify an active cursor if more than one cursor can appear, how to position a cursor, and how to use a cursor

d. Keyboard layout and role of different types of keys and pointing devices

e. Procedures for turning power off if special sequencing of operations is needed

4 .1.2 Access control. This paragraph shall present an overview of the access and security features of the software that are visible to the user. The following items shall be included, as applicable:

a. How and from whom to obtain a password

b. How to add, delete, or change passwords under user control

c. Security and privacy considerations pertaining to the storage and marking of output reports and other media that the user will generate

4.1.3 Installation and setup. This paragraph shall describe any procedures that the user must perform to be identified or authorized to access or install software on the equipment, to perform the installation, to configure the software, to delete or overwrite former files or data, and to enter parameters for software operation.

4.2 Initiating a session. This paragraph shall provide step-by-step procedures for beginning work, including any options available. A checklist for problem determination shall be included in case difficulties are encountered.

4.3 Stopping and suspending work. This paragraph shall describe how the user can cease or interrupt use of the software and how to determine whether normal termination or cessation has occurred.

5. Processing reference guide. This section shall provide the user with procedures for using the software. If procedures are complicated or extensive, additional Sections 6, 7, ... may be added in the same paragraph structure as this section and with titles meaningful to the sections selected. The organization of the document will depend on the characteristics of the software being documented. For example, one approach is to base the sections on the organizations in which users work, their assigned positions, their work sites, or the tasks they must perform. For other software, it may be more appropriate to have Section 5 be a guide to menus, Section 6 be a guide to the command language used, and Section 7 be a guide to functions. Detailed procedures are intended to be presented in subparagraphs of paragraph 5 .3. Depending on the design of the software, the subparagraphs might be organized on a function-by-function, menu-by-menu, transaction-by-transaction, or other basis. Safety precautions, marked by WARNING or CAUTION, shall be included where applicable.

5 .1 Capabilities. This paragraph shall briefly describe the interrelationships of the transactions, menus, functions, or other processes in order to provide an overview of the use of the software.

5.2 Conventions. This paragraph shall describe any conventions used by the software, such as the use of colors in displays, the use of audible alarms, the use of abbreviated vocabulary, and the use of rules for assigning names or codes.

5. 3 Processing procedures. This paragraph shall explain the organization of subsequent paragraphs, e.g., by function, by menu, by screen. Any necessary order in which procedures must be accomplished shall be described.

5.3.x (Aspect of software use). The title of this paragraph shall identify the function, menu, transaction, or other process being described. This paragraph shall describe and give options and examples, as applicable, of menus, graphical icons, data entry forms, user inputs, inputs from other software or hardware that may affect the software's interface with the user, outputs, diagnostic or error messages or alarms, and help facilities that can provide on-line descriptive or tutorial information. The format for presenting this information can be adapted to the particular characteristics of the software, but a consistent style of presentation shall be used, i.e., the descriptions of menus shall be consistent, the descriptions of transactions shall be consistent among themselves.

5.4 Related processing. This paragraph shall identify and describe any related batch, offline, or background processing performed by the software that is not invoked directly by the user and is not described in paragraph 5.3. Any user responsibilities to support this processing shall be specified.

D1-IPSC-81443A

5.5 Data backup. This paragraph shall describe procedures for creating and retaining backup data that. can be used to replace primary copies of data in event of errors, defects, malfunctions, or accidents.

5.6 Recovery from errors, malfunctions, and emergencies. This paragraph shall present detailed procedures for restart or recovery from errors or malfunctions occurring during processing and for ensuring continuity of operations in the event of emergencies.

5. 7 Messages. This paragraph shall list, or refer to an appendix that lists, all error messages, diagnostic messages, and information messages that can occur while accomplishing any of the user's functions. The meaning of each message and the action that should be taken after each such message shall be identified and described.

5.8 Quick-reference guide. If appropriate to the software, this paragraph shall provide or reference a quick-reference card or page for using the software. This quick-reference guide shall summarize, as applicable, frequently used function keys, control sequences, formats, commands, or other aspects of software use.

6. Notes. 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. If Section 5 has been expanded into section(s )6, ... , this section shall be numbered as the next section following section n.

A. Appendices. Appendices 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.).

END OF D1-IPSC-81443A.

DIDS 3

DID COTS

DIDS

DIDS

DID Cal Cert

DID ATP

DATA ITEM DESCRIPTION

Requirements:

DID Failure

DIDS 2

DID_COTS Manual

Product Drawings

Product Drawings DID

SUM