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
Software Quality Engineering Manual Flow Chart .----------------. | Customer | | "Needs" | | Software | '----------------' | V .--------------. .----------------. .----------------. | Schedule | | Software Dev. | | System Req. | | (Gantt Chart)|<---------| Plan. AKA me |----------------->| Analysis. AKA | |No need as | | thinking about| | me asking | |project | | how to code | | management | |should always | | monkey through | | what this | |be done using | | the project. | | widget has to | |the ASAP model| | | | do to sell. | '--------------' '----------------' '----------------' | | | | | | | | | V V V .--------------. .------------------. .----------------. | Resources | | Software Product |<---------------| System Design | |(People/Equip)| | Specification. | | Document (SSDD)| | Me and my | | AKA me telling | | AKA. Me | |computer. | | management what | | thinking about | |Always ask | | can be done given| | what kinda | |for a better | | lack of srceens | | hardware might | |computer with | | and ASAP model | | work with this | |more screens. | | that has been | | software. | '--------------' | choosen. | | | | |>--------. '----------------' '------------------' | | | | .-----|--------' | V | | V .------------------. | | .-----------------. | Interface Req. |--------------->| Hardware Config | | AKA read any | | | | AKA. Me | | protocol | | | | realizing that | | documents of | | | | no new hardware | | other devices | | | | is needed just | | that you may be | | | | lots of fudgin | | interfacing to | | | | on the old | '------------------' | | | hardware | | | | | platform. Bonus | | | .---------| to management |>----. | | | | '-----------------' | | | | | | | | | | | .--------------. V | | | | | Comp Systems | .------------------. | | | .------------------. | | Op Manual |<---------| Interface Design |<-----' | | Computer Resource| | |To be written | | | Document (IDD) | | .---------| Integration and | | |by software | | | Already written | | | | | Integration Doc | | |testers after | | | as protocol I | | | | | Management says | | |implementation| | | just read. | | | | | Lifecycle is as | | |This is to be | | '------------------' | | | | long as | | |sure manuals | | | | | | | profitable. | | |represent what| | | | | | | No changes | | |our product | | | | | | | should ever be | | |does not what | | | | | | | needed if project| | |we wanted it | | | | | | | is done "right" | | |to do. | | | | | | | | | '--------------' | | | | | '------------------' | | | | | | | | V | | | | .--------------. | .------------------. | | | .------------------. | | Software User|<---' | Software Req. |<--' | '----->| Use Case | | | Manual | | | Specification |<-----' | Document | | |To be written | | |AKA Me trying to | |Play with MS paint| | |by software | | |remember what the | |for a day until | | |testers after | | |initial goal of | |I get yelled at | | |implementation| | |product was. And | |for playing with | | |for same | | |when I remember | |paint instead of | | |reason as | | |write on post-it | |doing my real job | | |above |<---------|and stick on edge | |of coding :( | | | | | |of single too | |Then no more stick| | '--------------' | |small screen. | |figures. | | | | | |<---------------| (UCD) | | | | '------------------' '------------------' | | | | \ | |
The way it works at most places
| | V \ V | .--------------. | .------------------. \ .------------------. | | Software | | | Software Design | '----------->| System Test | | | Program |<---' .---| Document(s) |--------------->| Description | | | Manual (SPM)| | | (SDDs) | .----------->| (STD) |<---' |Skip this one | | |Written as the | | |AKA Tell Dave the | |management | | |overall module | | |test guy that new | |says we alreay| | |comments that | | |firmware is almost| |have too many | | |apear at the top | | |ready. Give him | |manuals | | |of each filethat | | |the stickey note | | | | |makes up the code | | |from screen and | '--------------' | |for the project | | |tell him to test | | | | | |for "this stuf" | | '------------------' | -------'------------------' | | | | | | V | | V .--------------. | .------------------. | | .------------------. | Data Item |<-----' | Computer Software| | | | Software | | Description | | Components/Units |---' | | Test Proceure |----. |AKA Use | | Written as | | | Use black box | | |descriptive | | comment above | | | testing as to | | |vaiable names | | each function | | | not waste time | | | |<-------->| CSCs & CSUs | | | showing Dave how | | '--------------' '------------------' | | things actually | | | | | work. | | | | '------------------' | | | | | | | V | | .--------------. .------------------. | .------------------. | | "Software" |<---------| Software Coding |>--------' | Coding Guidelines| | | (CSCI) | | "Code Monkeys" |<---------------| "Rule Book for | | | Outputed | | Spend %90 project| | Code-Monkeys | | | by compiler | | work here as it | | AKA | | | unless there | | is very important| | ALWAYS | | | are syntax | | and screens are | | Follow | | | errors avoid | | too few and too | | Cpt Vince's | | | these at all | | small | | advice. | | | costs. |------. '------------------' | (CGRBFCM) | | '--------------' | | '------------------' | /|\ | | | | | V | | | .----------------------. | | | | Formal Qualification |<-----------------------------------' | | | Testing (FQT)) | | | | | Dave does the actual | | | testing. | | | | '----------------------' | | | | | | | | | \|/ | V | .--------------. | .-------------------. .------------------. | | Firmware | | |Version Description| | Software Test |<---' | Support | | | Document (VDD) |<--------------| Report (STR) | | Manual (FSM)| | |Make sure to update| | Dave gives the | |Dont even | | |version number in | | thumbs up. | |bother asking | | |code or you might | '------------------' |as we are way | | |think you have the | |behind our | | |wrong version. | |original ASAP | | '-------------------' |plan. | | '--------------' | | | | .------------------. '-->| Release to the | | Customer | '------------------'
2nd half
"Look at the big brain on Brad"! (ref Pulp Fiction) Cyril comes through loud and clear. Yup, some companies just don't get it.
Good job describing it!
After a review, my OP is correct, all connections are the way they are supposed to be; for a "SQEM Light version."