This post describes the Embedded Software (SW) Design Documentation.
Main input documents for embedded SW design.
- SW Requirements Specification
- Hardware Software Interface (manual, Datasheet, etc)
Design documents to be created for embedded SW design
| Documentation | Purpose | Summary |
|---|---|---|
| SW design document | Retain SW design history. | Documentation of the SW design process |
| SW Internal Specification | Sharing SW detailed specifications. To keep SW change history and traceability. | Documents defining SW detailed specifications |
| SW External Specification | Sharing SW specifications with requester, etc. | Documents that define the specifications from the software’s external point of view |
Embedded SW engineer may document the followingIn fact, they often spend far more time creating documentation than coding and testing.
- SW Development Plan
- Q&A
- UNIT Verification
- SW integration test
- SW Qualification Test
- Review Minutes ・ KPI Data Sheet
