Skip to main content
College of Engineering
Capstone

Common Artifacts

Below are many different types of artifacts that could be used to document your project. This is not an exhaustive list, nor is it a list of required artifacts for your project.

Many (most) projects have multiple elements and documentation for your project should recognize that. For example, when a "hardware" project has significant software pieces, the software also needs to be documented well.

Your team must decide what documentation is needed for YOUR project. When questions arise, please consult with your coach, sponsor, and/or pod instructor.

Cybersecurity Elements of a Project

  1. Software Bill of Materials (SBOM): Detailed inventory of all software components, libraries, and dependencies.
  2. Security Requirements Specification: Detailed security requirements.
  3. Risk Assessment Reports: Analysis of potential security risks.
  4. Threat Modeling Diagrams: Visual representations of potential threats.
  5. Security Architecture Diagrams: Design of the security system.
  6. Security Policies and Procedures: Guidelines for maintaining security.
  7. Incident Response Plans: Steps to respond to security incidents.
  8. Penetration Testing Reports: Results from penetration tests.
  9. Vulnerability Assessment Reports: Analysis of system vulnerabilities.
  10. Compliance Reports: Documentation of compliance with security standards.
  11. User Access Control Documentation: Guidelines for managing user access.
  12. Encryption Standards: Specifications for data encryption.
  13. Audit Logs: Records of system activity.
  14. Security Training Materials: Training for staff on security protocols.
  15. Disaster Recovery Plans: Steps for recovering from security breaches.
  16. Network Security Diagrams: Design of network security measures.
  17. Firewall Configuration Reports: Settings and configurations of firewalls.
  18. Patch Management Plans: Strategies for applying software patches.
  19. Data Breach Response Plans: Steps for responding to data breaches.
  20. Security Metrics and KPIs: Measurements of security performance.

Computer Engineering Elements of a Project

  1. System Architecture Diagrams: Overall design of the system.
  2. Hardware Specifications: Details of hardware components.
  3. Firmware Design Documents: Structure and design of firmware.
  4. Microcontroller/Processor Specifications: Details of main processing units.
  5. Memory Maps: Layouts of memory usage.
  6. Interface Protocols: Communication standards used.
  7. Test Procedures: Steps for testing hardware and firmware.
  8. Test Reports: Results from testing processes.
  9. Bill of Materials (BOM): List of hardware components.
  10. Assembly Instructions: Steps for hardware assembly.
  11. Embedded Software Documentation: Details of software embedded in hardware.
  12. Interface Design Documents: Specifications for hardware interfaces.
  13. Timing Diagrams: Relationships between different signals.
  14. Power Consumption Reports: Analysis of power usage.
  15. Environmental Testing Reports: Results from testing in various conditions.
  16. Reliability Testing Reports: Outcomes of reliability assessments.
  17. Performance Benchmarks: Results from performance tests.
  18. Error Handling Procedures: Steps to address hardware and software errors.
  19. Upgrade and Maintenance Manuals: Guidelines for updating hardware.
  20. Security Protocols: Measures to ensure hardware security.

Electrical Engineering Elements of a Project

  1. Circuit Diagrams: Schematic representations of circuits.
  2. PCB Layouts: Designs for printed circuit boards.
  3. Wiring Diagrams: Electrical connections and layouts.
  4. Connector Pinout Diagrams: Details of connector pin configurations.
  5. Component Specifications: Details of electronic parts used.
  6. Simulation Results: Outcomes of circuit simulations.
  7. Test Procedures: Instructions for testing circuits.
  8. Test Reports: Documentation of test outcomes.
  9. Bill of Materials (BOM): List of electronic components.
  10. Assembly Instructions: Steps for building electronic assemblies.
  11. Datasheets: Specifications from component manufacturers.
  12. Schematic Symbols and Libraries: Reference for symbols used.
  13. Power Distribution Diagrams: Details of power allocation in circuits.
  14. Grounding and Shielding Plans: Strategies for managing electrical noise.
  15. Firmware Documentation: Details of embedded software.
  16. Signal Integrity Analysis: Assessments of signal quality.
  17. Electromagnetic Compatibility (EMC) Reports: Compliance with EMC standards.
  18. Design Review Documents: Feedback and recommendations from reviews.
  19. Failure Analysis Reports: Investigations of component failures.
  20. Reliability Analysis: Predictions of component lifespan and performance.

Manufacturing Engineering Elements of a Project

  1. Process Flow Diagrams: Sequences of manufacturing steps.
  2. Work Instructions: Detailed production steps.
  3. Tooling and Fixture Documentation: Details of tools used in production.
  4. Quality Control Plans: Methods for ensuring product quality.
  5. Inspection Reports: Results from quality inspections.
  6. Material Specifications: Details of materials used in manufacturing.
  7. Production Schedules: Timelines for manufacturing activities.
  8. Assembly Instructions: Steps for product assembly.
  9. Maintenance Manuals: Procedures for equipment upkeep.
  10. Safety Procedures: Guidelines for safe manufacturing processes.
  11. Manufacturing Process Plans: Detailed process descriptions.
  12. Equipment Calibration Records: Documentation of equipment calibration.
  13. Process Validation Reports: Verification of manufacturing processes.
  14. Defect Analysis Reports: Investigations of product defects.
  15. Packaging Specifications: Details of product packaging requirements.
  16. Shipping Instructions: Guidelines for transporting products.
  17. Inventory Management Plans: Strategies for managing materials and components.
  18. Lean Manufacturing Documents: Implementation of lean manufacturing principles.
  19. Continuous Improvement Plans: Strategies for ongoing process improvement.
  20. Supplier Quality Agreements: Standards and expectations for suppliers.

Mechanical Engineering Elements of a Project

  1. Part/Component Drawings: Detailed blueprints of individual parts.
  2. Assembly Drawings: Schematics showing how parts fit together.
  3. CAD Models: 3D representations of parts and assemblies.
  4. Material Specifications: Detailed descriptions of materials used.
  5. Bill of Materials (BOM): Comprehensive list of parts and materials.
  6. Finite Element Analysis (FEA) Reports: Structural integrity simulations.
  7. Thermal Analysis Reports: Assessments of thermal properties.
  8. Stress and Strain Analysis: Evaluations of material stress and deformation.
  9. Tolerance Stack-up Analysis: Impact of part tolerances on assembly.
  10. Prototype Testing Reports: Results from testing physical models.
  11. Assembly Instructions: Step-by-step build procedures.
  12. Manufacturing Process Plans: Detailed production processes.
  13. Quality Control Plans: Inspection and quality assurance methods.
  14. Inspection Reports: Results from part and assembly inspections.
  15. Safety Data Sheets (SDS): Information on material safety.
  16. Maintenance Manuals: Procedures for equipment upkeep.
  17. Tooling and Fixture Documentation: Details on tools used in production.
  18. Surface Finish Specifications: Requirements for part finishes.
  19. Load and Fatigue Analysis: Evaluations of part durability.
  20. Geometric Dimensioning and Tolerancing (GD&T): Specifications for part dimensions and tolerances.

Software Elements of a Project

  1. Requirements Specification: Detailed software requirements.
  2. System Architecture Diagrams: Overall design of the software system.
  3. Design Documents: Detailed design of software components.
  4. Software Bill of Materials (SBOM): Detailed inventory of all software components, libraries, and dependencies.
  5. Source Code: The actual software code.
  6. Build Instructions: Steps for compiling and building the software.
  7. Test Plans: Plans outlining tests to be conducted.
  8. Test Procedures: Steps for performing software tests.
  9. Test Reports: Documentation of test results.
  10. User Manuals: Instructions for end-users.
  11. Maintenance Manuals: Guidelines for maintaining and updating software.
  12. API Documentation: Details of application programming interfaces.
  13. Database Schemas: Structure of databases used.
  14. Release Notes: Information on software releases and updates.
  15. Configuration Management Plans: Strategies for managing software configurations.
  16. Bug Reports: Documentation of software defects.
  17. Change Logs: Records of changes made to the software.
  18. Security Assessment Reports: Evaluations of software security.
  19. Performance Testing Reports: Results from performance tests.
  20. Code Review Documents: Feedback from code reviews.
  21. Deployment Guides: Instructions for deploying software.