Systems Engineering Documentation

advertisement

I.

Appendix A - Sample Outlines

For Systems Engineering Documentation

Technical Plan (Prepared at Project Initiation)

Scope

A.

Document Overview

B.

System Overview – General description including sponsors, user agencies, etc.

I.

Project Description

A.

Glossary of Project Terms

B.

Preliminary, High Level, System Description

C.

Statement of Work Statement of Work

II.

Project Management Plan

A.

Work Breakdown Structure

B.

Activity Breakdown Structure

C.

Resource Loaded Network

D.

Schedules

E.

Technical Milestones

F.

Procurement Approach

G.

Deliverables

H.

Project Team Staffing Needs for each project phase

I.

Project Team Organization

III.

Systems Engineering Plan

A.

Technical Metrics

B.

Systems Engineering Life Cycle Model

C.

Process Models

D.

Gate and Exit Criteria (Criteria for proceeding to next step of the systems engineering process)

E.

Management Plans (CM, Interface, Risk, etc.)

F.

Technical Plans (Integration, Installation, etc.)

G.

Specification Tree (organization of specifications)

H.

Trade-off Studies (anticipated for planning and engineering process)

Sample Outline for Concept of Operations

I.

Scope

A.

Identification

B.

Document Overview

C.

System Overview

II.

Referenced documents

III.

Current system or situation

A.

Operational Policies and Constraints

B.

Description of the Current System or Situation

C.

Modes of Operation for the current System or Situation

IV.

Justification For and Nature of Changes

A.

Justification of Changes

B.

Description of Desired Changes

C.

Priorities Among Changes

D.

Changes Considered But Not Included

V.

Concepts for the proposed system (These are the subjects that are described in the course)

A.

Background, Objectives and Scope

B.

Deployment

C.

Practices and Procedures

D.

Performance

E.

Utilization Environment

F.

Effectiveness

G.

Life Cycle

H.

Environment

VI.

Operational scenarios

A.

Conditions for Scenarios

B.

Scenario Participants

C.

Sequence of Events

D.

Information Flows

VII.

Summary of Impacts

A.

Operational Impacts

B.

Organizational Impacts

C.

Impacts During Development

VIII.

Analysis of Proposed System

A.

Summary of Improvements

B.

Disadvantages and Limitations

C.

Alternatives and Trade-offs Considered

Sample Outline for Requirements Definition

I.

Scope

A.

Identification

B.

Document Overview

C.

System Overview

I.

Referenced Documents

II.

Definition of Requirements

A.

System Functions

B.

System Performance

C.

Tasks or Actions to be Performed

D.

Performance Constraints

E.

Unique Hardware or Software

III.

Process Information

A.

Verification Requirements (to include inspection, analysis/simulation, demonstration and test)

B.

Traceability

C.

Definition of Traceability Matrix

D.

Requirements and Requirements Database

E.

Validation Test Plan

IV.

Interfaces and Standards

A.

Interface Requirements

B.

Inter-Function Relationships

C.

Interface Definitions

D.

Standard Identification

Sample Outline for Design

The following outline does not strictly follow the traditional systems engineering process.

It has been adopted for use in the traditional preparation of Plans and Specifications used for the procurement of equipment and services.

I. Scope

A.

Identification

B.

Document Overview

C.

System Overview

II.

Referenced documents

III.

Overview of Design

IV.

Detailed design specifications

A.

System Specifications

B.

Subsystem Specifications

C.

Standards

D.

Testing

E.

Construction Standards

F.

Performance Specifications

G.

Transition Plans

H.

Government Furnished Facilities and Equipment

I.

Documentation Requirements

J.

Training Requirements

V.

Systems Engineering Processes

A.

Initial identification of risks

B.

Updated traceability matrix

A.

Analysis of solution alternatives

B.

Definition of preferred solution

C.

Updated technical requirements

D.

Allocation of requirements

E.

High level design specifications

F.

Integration strategy

G.

Integration plan

H.

Justification for Commercial off-the-shelf (COTS) products

Implementation

Numerous different types of documentation are required during this phase of the project.

This documentation includes updates of the documentation prepared during earlier phases. The general categories of documentation included during this phase:

Configuration

Product information

Interconnect

Data flows and protocols

Test results

Bug reports and disposition

Appendix B

Systems Engineering Reference Books

References

Title: Introduction to Systems Engineering

Author: Andrew P. Sage, James E. Armstrong , Jr.

Copyright: 2000

Publisher: Wiley

ISBN: 0-471-02766-9

Comment: This is a good introductory college level textbook. It has problem sets at the end of each chapter. There are also many bibliographic references for each chapter.

Title: Systems Engineering

Author: Andrew P. Sage

Copyright: 1992

Publisher: Wiley

ISBN: 0-471-53639-3

Comment: This is a good introductory college level textbook. It has problem sets at the end of each chapter. There are also many bibliographic references for each chapter.

Title: The Engineering and Design of Systems: Models and Methods

Author: Dennis M. Buede

Copyright: 2000

Publisher: Wiley

ISBN: 0-471-28225-1

Comment: This is a good advanced college level textbook. It has problem sets at the end of each chapter. There are also many bibliographic references for each chapter.

Title: Handbook of Systems Engineering and Management

Editors: Andrew P. Sage, William B. Rouse

Copyright: 1999

Publisher: Wiley

ISBN: 0-471-15405-9

Comment: This is a compendium of works from 40 contributing authors. At the end of each chapter are lists of additional references and a bibliography supporting the work.

NOTE: These books are a part of the publisher’s series of books on systems engineering.

At this time there are seventeen works in this series. The principal authors are from

George Mason University Systems Engineering & Operations Research Department.

This school offers B.S. and M.S. degrees in this field.

Title: Systems Engineering Guidebook: A Process for Developing Systems and Products

Editors: James N. Martin, A. Terry Bahill

Copyright: 1999

Publisher: Wiley

ISBN: 0849378370

Comment: This is a compendium of works from many contributing authors.

Title: Systems Engineering and Analysis

Author: Benjamin S. Blanchard, Wolter J. Fabrycky

Copyright: 1998

Publisher: Prentice Hall

ISBN: 0131350471

Title: Systems Engineering Management

Author: Benjamin S. Blanchard

Copyright: 1997

Publisher: Wiley

ISBN: 0471190861

Comment:

Title: Systems Engineering coping with complexity

Authors: Jackson, Brook, Stevens, Arnold

Copyright: 1998

Publisher: Prentice Hall

ISBN 0130950858

Comment: Excellent reference. Integration of Systems Engineering activities, e.g. CM,

Requirement Engineering, Verification and Validation.

Title: Visualizing Project Management

Author: Forsberg, Mooz, Cotterman

Copyright: 2000

Publisher: Wiley

ISBN: 047135760

Comment: Excellent reference on the Vee and the integration of Project Management and

Systems Engineering. CD is very good that comes with it.

Title: CMMI Distilled. A practical Introduction to Integrated Process Improvement.

Author: Ahern, Clouse, Turner

Copyright: 2001

Publisher: Addison-Wesley

ISBN: 0201735008

Comment: The CMMI is the replacement for SECAM and integrates, Software

Engineering, Systems Engineering and Integrated Product Team. Good introduction on

CMMI Capabilities Maturity Model.

Title: Systems Engineering Guidebook

Author: James N. Martin

Copyright: 1997

Publisher: CRC Press

ISBN: 0849378370

Comment: Jim leads the standard activity for INCOSE this book has good information that amplifies EIA 632.

Title: Systems Thinking, Systems Practice

Author: Peter Checkland

Copyright: Reprinted November 2000

Publisher: Wiley

ISBN: 0471986062

Comment: Considered a classic work in Systems Engineering and Systems Thinking.

Title: INCOSE Symposium papers

Author: Various

Copyright: INCOSE

Publisher: INCOSE (Available via www.incose.org )

ISBN:

Comment: 10 years of papers – From the initial INCOSE conference, wealth of SE information, available on CD.

Title: The Federal Aviation Administration Integrated Capability Maturity Model

Version 1

Author: Integrated Capability Maturity Model (FAA-iCMM

®

)

Copyright: November 1997

Publisher: INCOSE (Available via www.incose.org )

ISBN:

Comment: Free document available on the web at http://www.faa.gov/ait/ait5/Document/faaicmm.pdf

Title: Systems Engineering Fundamentals

Author: Department of Defense, Systems Management College

Copyright: December 2000

Publisher: Defense Acquisition University Press, Fort Belvoir, Virginia, 22060-5565

Title: Object-Oriented Project Management with UML

Author: Murray R. Cantor

Copyright: 1998

Publisher: Wiley Computer Publishing

ISBN: 0-471-25303-0

Reference Standards for Systems Engineering.

INCOSE Website, references, symposium papers, links to SE organizations http://incose.org/

SEI Website, http://www.sei.cmu.edu/cmmi/products/models.html

CMMI Systems, Software and Integrated Product Team Capability Maturity Model.

EIA/IS 632, Draft Standard: Processes for Engineering a System

ISO/IEC 15288 System Life Cycle Processes

IEEE 1220-1994, IEEE Trial-Use Standard for Application and Management of the

Systems Engineering Process.

SECAM: Systems Engineering Capability Assessment Model (version 1.5), INCOSE,

June 1996

EIA/IS 731 (SE-CMM): Bate, Roger, et. Al., Systems Engineering Capability Maturity

Model

IEEE 1362-1998, IEEE Guide for Information – System Definition – Concept of

Operations Document.

IEEE 830-1993, IEEE Recommended Practice for Software Requirements Specifications

IEEE 1012-1986, IEEE Standard for Software Verification and Validation Plans

IEEE 1233 IEEE Guide for Developing System Requirements Specifications

U.S. Air Force, Software Technology Support Center, Ogden Air Logistics Center, Hill

Air Force Base Utah, http://www.stsc.hill.af.mil/ Guide for Successful Acquisition and

Management of Software-Intensive Systems, Version 3.0 May 2000.

Download