Implement the Product Design
Product components, and associated support documentation, are implemented from their designs.
Product components are implemented from the designs established by the specific practices in the Develop the Design specific goal. The implementation usually includes unit testing of the product components
before sending them to product integration and development of enduser documentation.
SP 3.1 Implement the Design
Implement the designs of the product components.
For Software Engineering
Software code is a typical software product component.
Once the design has been completed, it is implemented as a product component. The characteristics of that implementation depend on the type of product component.
Design implementation at the top level of the product hierarchy involves the specification of each of the product components at the next level of the product hierarchy. This activity includes the allocation, refinement, and verification of each product component. It also involves the coordination between the various product-component development efforts.
Example characteristics of this implementation are as follows:
· Software is coded.
· Data is documented.
· Services are documented.
· Electrical and mechanical parts are fabricated.
· Product-unique manufacturing processes are put into operation.
· Processes are documented.
· Facilities are constructed.
· Materials are produced (e.g., a product-unique material could be a petroleum, oil, or lubricant, or a new alloy).
Typical Work Products
1. Implemented design
Subpractices
1. Use effective methods to implement the product components.
For Software Engineering
Examples of software coding methods include the following:
· Structured programming
· Object-oriented programming
· Automatic code generation
· Software code reuse
· Use of applicable design patterns
For Systems Engineering
Examples of appropriate fabrication methods include the following:
· Casting
· Molding
· Forming
· Joining
· Machining
· Tooling
· Welding
· Extruding
2. Adhere to applicable standards and criteria.
For Software Engineering
Examples of software coding standards include the following:
· Language standards
· Naming conventions for variables
· Acceptable language structures
· Structure and hierarchy of software product components
· Format of code and comments
For Software Engineering
Examples of software coding criteria include the following:
· Modularity
· Clarity
· Simplicity
· Structured (e.g., no GOTOs, one entrance, and one exit)
· Maintainability
For Systems Engineering
Examples of standards include the following:
· Standard Parts Lists
· Standard drawing requirements
· International Organization for Standardization (ISO) T3303 standards for manufactured parts
For Systems Engineering
Examples of criteria include the following:
· Maintainability
· Reliability
· Safety
3. Conduct peer reviews of the selected product components.
4. Perform unit testing of the product component as appropriate.
Note that unit testing is not limited to software. Unit testing involves the testing of individual hardware or software units or groups of related items prior to integration of those items.
5. Revise the product component as necessary.
An example of when the product component may need to be revised is when problems surface during implementation that could not be foreseen during design.
SP 3.2 Develop Product Support Documentation
Develop and maintain the end-use documentation.
This specific practice develops and maintains the documentation that will be used to install, operate, and maintain the product.
Typical Work Products
1. End-user training materials
2. User's manual
3. Operator's manual
4. Maintenance manual
5. Online help
Subpractices
1. Review the requirements, design, product, and test results to ensure that issues affecting the installation, operation, and maintenance documentation are identified and resolved.
2. Use effective methods to develop the installation, operation, and maintenance documentation.
3. Adhere to the applicable documentation standards.
Examples of documentation standards include the following:
· Compatibility with designated word processors
· Acceptable fonts
· Numbering of pages, sections, and paragraphs
· Consistency with a designated style manual
· Use of abbreviations
· Security classification markings
· Internationalization requirements
4. Develop preliminary versions of the installation, operation, and maintenance documentation in early phases of the project life cycle for review by the relevant stakeholders.
5. Conduct peer reviews of the installation, operation, and maintenance documentation.
6. Revise the installation, operation, and maintenance documentation as necessary.
Examples of when documentation may need to be revised include when the following events occur:
· Requirements change
· Design changes are made
· Product changes are made
· Documentation errors are identified
· Workaround fixes are identified
