This is a "Quick-n-Dirty" SQEM (Software Quality Engineering Manual) flow chart: (NOTE: Most "software engineers" only bother with the 'red' portions)
Software Quality Engineering Manual Flow Chart .----------------. | System Spec. | | (EICD) | (Electrical Interface Control Drawing) '----------------' | V .--------------. .----------------. .----------------. | Schedule | | Software Dev. | | System Req. | | (Gantt Chart)|<---------| Plan (SDP) |----------------->| Analysis (SRA) | '--------------' '----------------' '----------------' | | | V V V .--------------. .------------------. .----------------. | Resources | | Software Product |<---------------| System Design | |(People/Equip)| | Specification | | Document (SSDD)| '--------------' | (SPP) |>--------. '----------------' '------------------' | | | | .-----|--------' | V | | V .------------------. | | .-----------------. | Interface Req. |--------------->| Hardware Config | | Specification | | .---------| Interface (HWCI)|>----. | (IRS) | | | | '-----------------' | '------------------' | | | | | | | | | .--------------. V | | | | | Comp Systems | .------------------. | | | .------------------. | | Op Manual |<---------| Interface Design |<-----' | | Computer Resource| | | (CSCM) | | | Document (IDD) | | .---------| Integration and | | '--------------' | '------------------' | | | | Integration Doc | | | | | | | | (CRISD) | | | | | | | '------------------' | | | | | | | | V | | | | .--------------. | .------------------. | | | .------------------. | | Software User|<---' | Software Req. |<--' | '----->| Use Case | | | Manual | | Specification |<-----' | Document | | | (SUM) |<---------| (SRS) |<---------------| (UCD) | | '--------------' | '------------------' '------------------' | | | \ | | | V \ V | .--------------. | .------------------. \ .------------------. | | Software | | | Software Design | '----------->| System Test | | | Program |<---' .---| Document(s) |--------------->| Description | | | Manual (SPM)| | | (SDDs) | .----------->| (STD) |<---' '--------------' | '------------------' | /'------------------' | | | / | | V | / V .--------------. | .------------------. | / .------------------. | Data Item |<-----' | Computer Software| | / | Software | | Description | | Components/Units |---' / | Test Proceure |----. | (DID) |<-------->| CSCs & CSUs | / | (STP) | | '--------------' '------------------' / '------------------' | | / | V / | .--------------. .------------------. / .------------------. | | "Software" |<---------| Software Coding |>---' | Coding Guidelines| | | (CSCI) | | "Code Monkeys" |<---------------| "Rule Book for | | | Executable |------. '------------------' | Code-Monkeys | | '--------------' | | | (CGRBFCM) | | /|\ | | '------------------' | | | V | | | .----------------------. | | | | Formal Qualification |<-----------------------------------' | | | Testing (FQT)) | | | | '----------------------' | | | | | | | | | \|/ | V | .--------------. | .-------------------. .------------------. | | Firmware | | |Version Description| | Software Test |<---' | Support | | | Document (VDD) |<--------------| Report (STR)or | | Manual (FSM)| | '-------------------' '------------------' '--------------' | | | | .------------------. '-->| Release to the | | Customer | '------------------'
(NOTE: ASCII art isn't fun)
The above is an iterative process.
--Cpt. Vince Foster 2nd Cannon Place Fort Marcy Park, VA
A summary of documents:
EICD = Electrical Interface Control Document SDP = Software Development Plan SRA = System Requirements Analysis SPP = Software Product Specification SSDD = System Design Document HWCI = Hardware Configuration Interface IRS = Interface Requirements Specification IDD = Interface Design Document CRISD = Computer Resource Integration Support Document SRS = Software Requirements Specification UCD = Use Case Document SDD(s) = Software Design Document(s) STD = System Test Desecription STP = Software Test Procedure STR - Software Test Report CSC = Computer Software Component (higher level than CSU) CSU = Computer Software Unit (low level psuedo code) SCM = Supid Code-Monkey CGRBFCM = Coding Guidlines Rule Book for Coding Monkeys SCM = Stupid Code Monkeying in "C", Assebly, etc VDD = Version Description Document CSCM = Computer System's Operations Manual SUM = Software User's Manual SPM = Software Programmers Manual DID = Data Item Description CSCI = Computer Software Configuration Item (the executable) FSM = Firmware Support Manual
Well, at least that is what it takes to be a 'software engineer.'
There are plenty of omitted documents, and not all of them may apply to your application: just know they exists.
Actually, that's just a list of their titles (& abbreviations) - it doesn't describe the purpose & what should be in each of those documents!
In particular, "Electrical Interface Control Document" doesn't sound a very apt name for the root specification of life, the universe, and everything - as the project sees it...