MIL-STD-498 Application & Reference Guidebook 31 Jan 1996 PDF
Preview MIL-STD-498 Application & Reference Guidebook 31 Jan 1996
(PDF version) MIL-STD-498 Application and Reference Guidebook Page 25 5. REFERENCE GUIDE This section provides a reference guide for an acquirer on selected topics found in MIL-STD-498, Software Development and Documentation. This section assumes a basic knowledge of system and software acquisition and software development. This reference does not attempt to provide a comprehensive coverage of these topics. It is intended to assist the acquirer in understanding the scope of the requirements for selected topics found in the standard, clarify the intention of the standard in regard to the topic, and describe the acquirer's responsibilities and considerations when applying the standard's requirements for the topic. The topics are arranged in alphabetical order, with page footers containing the topic names, to assist the reader in locating information. Each topic description is divided into four subparagraphs: 1) Paragraph 5.x.1 summarizes the key topic-related requirements in the standard. When specific MIL-STD-498 references exist, this section contains a figure providing an index of relevant references to the topic. Within this index, MIL-STD-498 requirements are indicated with normal text; explanatory or non-mandatory references are indicated with italicized text. When applicable, this section contains a second figure listing key developer activities related to the topic. 2) Paragraph 5.x.2 discusses acquirer responsibilities and provides some issues for consideration, including lessons learned regarding the topic. 3) Paragraph 5.x.3 lists topic-related questions. The questions are intended to provide acquirers and developers with "things to think about" over the course of the project. These questions are candidates for discussion at joint reviews and may help surface and resolve problematic issues. 4) Paragraph 5.x.4 contains a list of topics found elsewhere in this guidebook that are related to the topic being discussed. (PDF version) MIL-STD-498 Application and Reference Guidebook Page 26 Section 5 topics are intended as stand-alone references on an individual topic. To minimize repetitive definitions of often used acronyms, the most commonly used acronyms include: CALS Continuous Acquisition and Life-cycle Support CDRL Contract Data Requirements List CLIN Contract Line Item Number COTS Commercial-off-the-shelf DFARS Defense FAR Supplement DID Data Item Description FAR Federal Acquisition Regulation NDI Non-developmental Item SDF Software Development File SDL Software Development Library SDP Software Development Plan SOW Statement of Work To aid users in correlating this MIL-STD-498 Application and Reference Guidebook's topics to relevant MIL-STD-498 activities and DIDs, two indexes are provided on the following pages. (cid:159) Figure 7 -- MIL-STD-498-to-Topic Index. Figure 7 provides an index from each MIL-STD-498 paragraph to applicable topics. Each activity in MIL-STD-498 is listed with its corresponding key related topics. Additional references to other related topics are provided in paragraph 5.x.4 of each relevant topic. (cid:159) Figure 8 -- Topic-to-MIL-STD-498 DIDs Index. Figure 8 provides an index between topics and the MIL-STD-498's DIDs. Each topic in this guidebook is listed along with any DID that provides requirements for information relevant to that topic. (PDF version) MIL-STD-498 Application and Reference Guidebook Page 27 MIL-STD-498 PARAGRAPH KEY RELATED GUIDEBOOK TOPICS 1. SCOPE N/A 1.1 Purpose None 1.2 Application N/A 1.2.1 Organizations and agreements 5.10 Contract 5.11 Contract data requirements list 5.25 In-house development 5.69 Statement of work 1.2.2 Contract-specific application 5.10 Contract 5.49 Software development environment 5.55 Software engineering environment 5.63 Software test environment 1.2.3 Tailoring See MIL-STD-498 Overview and Tailoring Guidebook 1.2.4 Interpretation of selected terms 5.7 CASE tools 5.22 Documentation (Recording information) 5.40 Reengineering 5.43 Reusable software products 5.71 System/subsystem 1.3 Order of precedence None 2. REFERENCED DOCUMENTS N/A 3. DEFINITIONS N/A 4. GENERAL REQUIREMENTS N/A 4.1 Software development process 5.54 Software development process 4.2 General requirements for software N/A development 4.2.1 Software development methods 5.52 Software development methods 4.2.2 Standards for software products 5.68 Standards for software products 4.2.3 Reusable software products (including 5.8 Commercial-off-the-shelf software products 4.2.3.1, 4.2.3.2) 5.18 Data rights 5.31 Licenses (Software) 5.43 Reusable software products 4.2.4 Handling of critical requirements 5.14 Critical requirements (including 4.2.4.1 - 4.2.4.4) 5.45 Safety 5.47 Security and privacy 4.2.5 Computer hardware resource utilization 5.9 Computer hardware resource utilization 4.2.6 Recording rationale 5.39 Rationale/key decisions 4.2.7 Access for acquirer review 5.2 Access for acquirer review 5.15 Data accession list 5.33 Oversight FIGURE 7. MIL-STD-498-to-topic index. (PDF version) MIL-STD-498 Application and Reference Guidebook Page 28 MIL-STD-498 PARAGRAPH KEY RELATED GUIDEBOOK TOPICS 5. DETAILED REQUIREMENTS N/A 5.1 Project planning and oversight N/A 5.1.1 Software development planning 5.53 Software development planning 5.1.2 CSCI test planning 5.38 Qualification testing 5.63 Software test environment 5.1.3 System test planning 5.38 Qualification testing 5.63 Software test environment 5.1.4 Software installation planning 5.27 Installation (User site(s)) 5.66 Software user manuals 5.1.5 Software transition planning 5.26 Installation (Support environment) 5.61 Software support 5.62 Software support manuals 5.64 Software transition 5.1.6 Following and updating plans 5.3 Approval by the acquirer 5.53 Software development planning 5.2 Establishing a software development N/A environment 5.2.1 Software engineering environment 5.49 Software development environment 5.55 Software engineering environment 5.2.2 Software test environment 5.63 Software test environment 5.2.3 Software development library 5.51 Software development library 5.2.4 Software development files 5.50 Software development files 5.2.5 Non-deliverable software 5.49 Software development environment 5.3 System requirements analysis N/A 5.3.1 Analysis of user input 5.32 Operational concept 5.3.2 Operational concept 5.32 Operational concept 5.3.3 System requirements 5.1 Acceptance by the acquirer 5.29 Interfaces 5.41 Requirements 5.71 System/subsystem 5.74 Traceability 5.4 System design N/A 5.4.1 System-wide design decisions 5.5 Behavioral design 5.16 Database design 5.71 System/subsystem 5.72 System/subsystem-wide and CSCI-wide design 5.4.2 System architectural design 5.4 Architectural design 5.29 Interfaces 5.71 System/subsystem 5.74 Traceability FIGURE 7. MIL-STD-498-to-topic index - (continued). (PDF version) MIL-STD-498 Application and Reference Guidebook Page 29 MIL-STD-498 PARAGRAPH KEY RELATED GUIDEBOOK TOPICS 5.5 Software requirements analysis 5.1 Acceptance by the acquirer 5.29 Interfaces 5.41 Requirements 5.74 Traceability 5.6 Software design N/A 5.6.1 CSCI-wide design decisions 5.5 Behavioral design 5.16 Database design 5.72 System/subsystem-wide and CSCI-wide design 5.6.2 CSCI architectural design 5.4 Architectural design 5.29 Interfaces 5.74 Traceability 5.6.3 CSCI detailed design 5.16 Database design 5.20 Detailed design 5.29 Interfaces 5.74 Traceability 5.7 Software implementation and unit testing 5.17 Databases (including 5.7.1 - 5.7.5) 5.37 Programming languages 5.50 Software development files 5.56 Software implementation and unit testing 5.65 Software unit 5.67 Source files 5.73 Testing (Developer-internal) 5.8 Unit integration and testing (including 5.8.1 - 5.50 Software development files 5.8.4) 5.73 Testing (Developer-internal) 5.9 CSCI qualification testing (including 5.9.1 - 5.38 Qualification testing 5.9.7) 5.74 Traceability 5.10 CSCI/HWCI integration and testing (including 5.50 Software development files 5.10.1 - 5.10.4) 5.73 Testing (Developer-internal) 5.11 System qualification testing (including 5.11.1 5.38 Qualification testing - 5.11.7) 5.74 Traceability 5.12 Preparing for software use N/A 5.12.1 Preparing the executable software 5.23 Executable software 5.12.2 Preparing version descriptions for user 5.75 Version/revision/release sites 5.12.3 Preparing user manuals 5.66 Software user manuals 5.12.4 Installation at user sites 5.27 Installation (User site(s)) FIGURE 7. MIL-STD-498-to-topic index - (continued). (PDF version) MIL-STD-498 Application and Reference Guidebook Page 30 MIL-STD-498 PARAGRAPH KEY RELATED GUIDEBOOK TOPICS 5.13 Preparing for software transition N/A 5.13.1 Preparing the executable software 5.23 Executable software 5.13.2 Preparing source files 5.67 Source files 5.13.3 Preparing version descriptions for the 5.75 Version/revision/release support site 5.13.4 Preparing the "as built" CSCI design 5.64 Software transition and related information 5.13.5 Updating the system design 5.64 Software transition descriptions 5.13.6 Preparing support manuals (including 5.62 Software support manuals 5.13.6.1 - 5.13.6.2) 5.13.7 Transition to the designated support 5.26 Installation (Support environment) site 5.61 Software support 5.64 Software transition 5.14 Software configuration management 5.48 Software configuration management (including 5.14.1 - 5.14.5) 5.15 Software product evaluation (including 5.15.1 5.59 Software product evaluation - 5.15.3) 5.16 Software quality assurance (including 5.16.1 5.60 Software quality assurance - 5.16.3) 5.17 Corrective action N/A 5.17.1 Problem/change reports 5.35 Problem/change report 5.17.2 Corrective action system 5.12 Corrective action 5.18 Joint technical and management reviews 5.30 Joint technical and management reviews (including 5.18.1 - 5.18.2) 5.19 Other activities N/A 5.19.1 Risk management 5.33 Oversight 5.44 Risk management 5.19.2 Software management indicators 5.58 Software management indicators 5.19.3 Security and privacy 5.47 Security and privacy 5.19.4 Subcontractor management 5.70 Subcontractor management 5.19.5 Interface with software IV&V agents 5.24 Independent verification and validation 5.19.6 Coordination with associate developers None 5.19.7 Improvement of project processes 5.36 Process improvement FIGURE 7. MIL-STD-498-to-topic index - (continued). (PDF version) MIL-STD-498 Application and Reference Guidebook Page 31 MIL-STD-498 PARAGRAPH KEY RELATED GUIDEBOOK TOPICS 6. NOTES N/A 6.1 Intended use None 6.2 Data requirements 5.11 Contract data requirements list 6.3 Relationship between standard and CDRL 5.11 Contract data requirements list 6.4 Delivery of tool contents 5.7 CASE tools 5.11 Contract data requirements list 6.5 Tailoring guidance 5.11 Contract data requirements list 5.42 Requirements of the standard 5.69 Statement of work 6.6 Cost/schedule reporting 5.13 Cost estimation 5.46 Schedules 6.7 Related standardization documents 5.69 Statement of work 6.8 Subject term (key word) listing N/A APPENDIX A LIST OF ACRONYMS Appendix A - List of acronyms APPENDIX B INTERPRETING MIL-STD-498 FOR 5.43 Reusable software products INCORPORATION OF REUSABLE SOFTWARE PRODUCTS APPENDIX C CATEGORY AND PRIORITY 5.34 Problem category and priority classification CLASSIFICATIONS FOR PROBLEM REPORTING APPENDIX D SOFTWARE PRODUCT 5.59 Software product evaluation EVALUATIONS APPENDIX E CANDIDATE JOINT MANAGEMENT 5.30 Joint technical and management reviews REVIEWS APPENDIX F CANDIDATE MANAGEMENT 5.58 Software management indicators INDICATORS APPENDIX GGUIDANCE ON PROGRAM 5.6 Builds STRATEGIES, TAILORING, AND 5.54 Software development process BUILD PLANNING 5.57 Software life cycle processes Also see MIL-STD-498 Overview & Tailoring Guidebook APPENDIX H GUIDANCE ON ORDERING 5.11 Contract data requirements list DELIVERABLES 5.21 Documentation (Preparing documents) 5.22 Documentation (Recording information) 5.46 Schedules APPENDIX I CONVERSION GUIDE FROM N/A DOD-STD-2167A AND DOD-STD-7935A FIGURE 7. MIL-STD-498-to-topic index - (continued). (PDF version) MIL-STD-498 Application and Reference Guidebook Page 32 MIL-STD-498 Data Item Descriptions (DIDs) Application and Reference Topic C C D F I I O S S S S S S S S S S S S S S S O P B S D R C C D D I I P R S S T T T T U V M M D M D S D O D P O P S S D S D P R r M D D M M D P (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.1 Acceptance by the acquirer (cid:159) 5.2 Access for acquirer review (cid:159) 5.3 Approval by the acquirer (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.4 Architectural design (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.5 Behavioral design (cid:159) (cid:159) (cid:159) (cid:159) 5.6 Builds (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.7 CASE tools 5.8 Commercial-off-the- shelf software products (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.9 Computer hardware resource utilization (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.10 Contract (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.11 Contract data requirements list (cid:159) (cid:159) 5.12 Corrective action 5.13 Cost estimation (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.14 Critical requirements 5.15 Data accession list (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.16 Database design (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.17 Databases (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.18 Data rights (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.19 Data standardization (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.20 Detailed design 5.21 Documentation (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (Preparing documents) 5.22 Documentation (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (Recording information) (cid:159) (cid:159) (cid:159) 5.23 Executable software 5.24 Independent (cid:159) verification and validation (cid:159) 5.25 In-house development (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.26 Installation (Support environment) FIGURE 8. Topic to MIL-STD-498 DIDs index. (PDF version) MIL-STD-498 Application and Reference Guidebook Page 33 MIL-STD-498 Data Item Descriptions (DIDs) Application and Reference Topic C C D F I I O S S S S S S S S S S S S S S S O P B S D R C C D D I I P R S S T T T T U V M M D M D S D O D P O P S S D S D P R r M D D M M D P (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.27 Installation (User site(s)) 5.28 Integrated product team (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.29 Interfaces 5.30 Joint technical and (cid:159) management reviews (cid:159) (cid:159) 5.31 Licenses (Software) (cid:159) (cid:159) 5.32 Operational concept (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.33 Oversight 5.34 Problem category and (cid:159) priority classifications (cid:159) (cid:159) (cid:159) 5.35 Problem/change report (cid:159) 5.36 Process improvement (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.37 Programming languages (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.38 Qualification testing (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.39 Rationale/key decisions (cid:159) (cid:159) (cid:159) 5.40 Reengineering (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.41 Requirements (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.42 Requirements of the standard (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.43 Reusable software products (cid:159) 5.44 Risk management (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.45 Safety (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.46 Schedules (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.47 Security and privacy 5.48 Software configuration (cid:159) (cid:159) management 5.49 Software development (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) environment (cid:159) (cid:159) (cid:159) (cid:159) 5.50 Software development files (cid:159) 5.51 Software development library 5.52 Software development (cid:159) methods FIGURE 8. Topic to MIL-STD-498 DIDs index - (continued). (PDF version) MIL-STD-498 Application and Reference Guidebook Page 34 MIL-STD-498 Data Item Descriptions (DIDs) Application and Reference Topic C C D F I I O S S S S S S S S S S S S S S S O P B S D R C C D D I I P R S S T T T T U V M M D M D S D O D P O P S S D S D P R r M D D M M D P 5.53 Software development (cid:159) planning 5.54 Software development (cid:159) process 5.55 Software engineering (cid:159) (cid:159) (cid:159) environment 5.56 Software (cid:159) (cid:159) implementation and unit testing (cid:159) 5.57 Software life cycle processes 5.58 Software (cid:159) management indicators (cid:159) 5.59 Software product evaluation (cid:159) 5.60 Software quality assurance (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.61 Software support (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.62 Software support manuals (cid:159) (cid:159) (cid:159) 5.63 Software test environment (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.64 Software transition (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.65 Software unit (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.66 Software user manuals (cid:159) (cid:159) (cid:159) 5.67 Source files (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.68 Standards for software products 5.69 Statement of work (cid:159) (cid:159) (cid:159) 5.70 Subcontractor management (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.71 System/subsystem 5.72 System/subsystem- (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) wide and CSCI-wide design (cid:159) 5.73 Testing (Developer- internal) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.74 Traceability (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) (cid:159) 5.75 Version/revision/ release FIGURE 8. Topic to MIL-STD-498 DIDs index - (continued).
The list of books you might like
