Documenting the Development Process for Open Source Embedded Systems Projects - README

Development Process Aims

• Ease communication between clients and developers
• Open Source design principles
• Tracing of Design decisions
• Change Control
• Process adaptable for projects of different sizes

Documentation Overview

Design documents will follow this template during development process

• [0] Client requests development of open source Embedded Systems project.

• [1]Requirements Capture

  • [1.1] Project Brief
  • [1.2] High Level Requirements Description
  • [1.3] Requirements Capture
  • Requirements Review? Validation? Sign Off?

• [2]Low Level Requirements Capture

  • [2.1] Validated High Level Requirements
  • [2.2] Low Level Requirements Description
  • [2.3] Low Level Requirements Capture
    • [2.3.1] Hardware Requirements
    • [2.3.1] Software Requirements
  • Requirements Review? Validation? Sign Off?
  • [2.4] Requirements Matrix <- NOTE: here or in seperate document?

• [3]Detailed Design Documents

  • Hardware Specification
  • Software Specification
  • PCB Design Documents
  • Code
    

• [4]Verification Documents

  • Verification Testing Procedures
    • Tested against requirements
  • Test Results
  • Evaluation of test results against requirements documents

• [5]System Commission Documents

  • Handover/Signoff
  • User End Documentation
    • User Guides
    • Safety Information

• [6]Decommissioning & End of Life Documents