This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Component Design

Component Design

Component Documentation

1 - CF009A_GmOvrlStMgr_Design_PeerReviewChkList

Nexteer_Template_V1.0

Overview

Peer Review Instructions
Technical Review Checklist
Template Change Log


Sheet 1: Peer Review Instructions

Instructions for Functional Design Package Peer Review




PRE-MEETING


Function OwnerConfirm that requirements are reviewed and approved PRIOR to the FDP peer review

Function OwnerStart with latest version of the template for any "first reviews" - Continue to use existing temmplate for re-reviews

Function OwnerProvide the functional design package (changed documents) to the invited attendees 1-2 working days in advance of review

Function OwnerNotify the assigned peer reviewer and make sure they are prepared to do their function in the meeting

Function OwnerIdentify necessary attendance and invite to meeting

Function OwnerComplete the "Author" column information for sections 1 through 5 prior to the review

Function OwnerComplete the attendance invitation list in section 7

Function OwnerFor Re-reviews only: Complete the column "remarks by author" to identify actions taken to address items found in earlier reviews.



DURING MEETING


Function OwnerPresent document changes to the review team

Peer ReviewerCapture attendance of the review

Peer ReviewerCapture actions and issues in section 6. Identify issue summary, Document type, Reference (Requirement ID, section number, etc), Defect Type and indicate status as "OPEN"



POST MEETING


Function OwnerFollow up on all "open" items. Update "Summary of Resolution" to indicate what was done or decided.

Function OwnerSchedule follow up review OR review open items with peer reviewer and obtain agreement to close

Peer ReviewerClose change request in system and confirm all associated tasks are complete. Upload peer review checklist (this document) with any FDP updates

Sheet 2: Technical Review Checklist

Technical Review Checklist - Template Version 02.02.00







Product NameElectric Power SteeringElectrical Arch.4Review ScopeDefect TypeNumbers




YesClosedFR
Function IDCF009A_GmOvrlStMgr

EA4#6873Requirement0




NoRejectedFDD
Long NameGM Overlay State Manager

Interface0




NAOpenModel
Version that you started from. NOT the version you hope to release. If this will be v1.0.0, enter NA. Starting Baseline3.1.0EffortDesign1






FMEA
AuthorSudeep ShankarReview Effort(Hrs.)1.00Standards0






*.m File


Corr+Verf effort(Hrs.)0.25Documentation0






Cal Process


Total Effort (Hrs.)1.25Others3













Total4







Checklist No.Description of CheckAuthor: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. AuthorAuthor: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. ReviewerAuthor: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewerAuthor: Defect type to be selected. Defect TypeAuthor: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By AuthorAuthor: Data in this column shall be filled by reviewer after checking whether the rework is completed. Status







1Section 1: Data Dictionary














Is Filename of Data Dictionary in correct format?YesYes












Is the FDD.Version property correctly updated?YesYes












Is the Data Dictionary Verification report error free?NoNoAccepted with errors
NTC number is found in the model but not in the DD, The NTC in the DD is named.Closed








Does FDD Long Name, Short Name, and Description match requirements?YesNo












Are all runnables defined?YesYes












Do runnables have the correct time step?YesYes












Do server runnables correctly define arguments?YesYes












Are all clients defined?YesYes












Do client definitions match the corresponding server runnable?YesYes












Does name and metadata of every signal match its corresponding interface signal?YesYes












Do output signal ranges match requirements (check DOOR min/max attributes too)?YesYes












Are calibration tables named correctly (e.g. AssiX and AssiY)?YesYes












Are all data types represented by released Data_Management classes?YesYes












Do all calibrations have correct values for all metadata?YesYes












Is NVM defined in the appropriate number of blocks?YesYes












Are constants defined with proper scope (local vs global)?YesYes












Are all dependent constants and calibrations included in one file?YesYes












Does FDD.DesignASIL match requirements?YesYes


























2Section 2: ModelAuthor: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. AuthorAuthor: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. ReviewerAuthor: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewerAuthor: Defect type to be selected. Defect TypeAuthor: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By AuthorAuthor: Data in this column shall be filled by reviewer after checking whether the rework is completed. Status








Is filename of model in correct format?YesYes












Is Top level of model annotated with Requirements Baseline?NANo












Is the Top level of the model annotated with Tool Dependencies?YesYes












Is Top level of model annotated with Change Log or History?NoYes












Is the 2nd level of model free from subsystems that are not Function-Call Subsystems?YesYes












Is the 2nd level of model free from arithmetic and logic operations?YesYes












Are the Runnable trigger signals named as "call_<Runnable>"?YesYes












Does 2nd level of model have a properly updated annotation with name, description, and intended baseline number?YesYes












Are all data flow layers free of Function-Call Subsystems and Memory Store blocks?YesYes












Does the Model have the confidentiality and copyright information inside all its Subsystems?YesYes












Are all the Memory Store blocks for PIM and Display Variables located on the 2nd level of model?YesYes












Is each diagnostic (NTC) capable of being set to "PASS"?YesYes












Does non-zero intialization of PIM occur in the function's Init runnable?YesYes












Does design properly include Set Ram Block Status when NVM RAM values change?YesYes












Does model include appropriate logic for dealing with missing or corrupted NVM data?YesYes












Does model execute without errors/warnings after loading NxtrMBDConfig configuration set?YesYes



























3Section 3: Requirements LinkingAuthor: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. AuthorAuthor: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. ReviewerAuthor: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewerAuthor: Defect type to be selected. Defect TypeAuthor: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By AuthorAuthor: Data in this column shall be filled by reviewer after checking whether the rework is completed. Status








Are all requirements links of the format <FDDNumber>_<ObjectID>?NANoReport was not placed in delivery packageOthersDue to time constraint, peer review team agreed for not linking requirements at present as there are 200+ requirements that needs to be linked.Closed








Does requirements HTML report reference only the DOORS module of this component for all links in the design?NANoReport was not placed in delivery packageOthersSame as aboveClosed








Are linked blocks linked to the correct requirements(s)? (watch for problems due to copy/pasted blocks)NANoReport was not placed in delivery packageOthersSame as aboveClosed








Is the list of unlinked blocks acceptable?NANA



























4Section 4: Model AdvisorAuthor: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. AuthorAuthor: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. ReviewerAuthor: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewerAuthor: Defect type to be selected. Defect TypeAuthor: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By AuthorAuthor: Data in this column shall be filled by reviewer after checking whether the rework is completed. Status








Was Model Advisor run with the correct configuration settings?YesYes












Is the Model Advisor rerport free from "Fails".NoNoAccepted with errors
The Simscape licence failed check out.Closed








Are Model Advisor report "Warnings" acceptable?YesYes



























5Section 5: Delivery PackageAuthor: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. AuthorAuthor: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. ReviewerAuthor: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewerAuthor: Defect type to be selected. Defect TypeAuthor: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By AuthorAuthor: Data in this column shall be filled by reviewer after checking whether the rework is completed. Status








Does Design folder contain only the model, data dictionary, and (optionally) a simulation setup script?YesYes












Does Doc folder contain a zipped HTML webview model?YesYes












Was webview model created without requirements highlighted?YesYes












Does Reports folder contain only the data dictionary verification report, Model Advisor report, and zipped requirements traceability report?NoNo

No Requirements report generated. Please refer requirement linking sectionClosed























4Section 6: Other Issus/Actions IdentifiedDocumentReferenceSummary of resolutionAuthor: Defect type to be selected. Defect TypeAuthor: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By AuthorAuthor: Data in this column shall be filled by reviewer after checking whether the rework is completed. Status







4.1Add reset timer logic in the path givenModelCF009A_GmOvrlStMgr/GmOvrlStMgr/GmOvrlStMgrPer1/LKAIntv/HwTqLkaTqSignEquAdd timer resetDesignAdded timer resetClosed







4.2














4.3














4.4














4.5














4.6














4.7














4.8














4.9














4.10














4.11














4.12














4.13














4.14














4.15














4.16














4.17














4.18














4.19














4.20














4.21














4.22














4.23














4.24














4.25














5Section 7: APPROVALS













RoleFirst ReviewDateAttendanceApproval?










Function Owner*Matt Tompkins8/19/2016YesYes










Peer Reviewer*Price LeflerYesYes










Safety<Name - if invited>












SoftwareNick SaxtonYesYes










ESG / SystemsVenkata SivanandYesYes










EPDT / CSE<Name - if invited>












Hardware<Name - if invited>












Test<Name - if invited>












RoleSecond Review (if required)DateAttendanceApproval?










Function Owner*<Owner Name>













Peer Reviewer*<Name>












Safety<Name - if invited>












Software<Name - if invited>












ESG / Systems<Name - if invited>












EPDT / CSE<Name - if invited>












Hardware<Name - if invited>












Test<Name - if invited>












RoleThird Review (if required)DateAttendanceApproval?










Function Owner*<Owner Name>













Peer Reviewer*<Name>












Safety<Name - if invited>












Software<Name - if invited>












ESG / Systems<Name - if invited>












EPDT / CSE<Name - if invited>












Hardware<Name - if invited>












Test<Name - if invited>












RoleFourth Review (if required)DateAttendanceApproval?










Function Owner*<Owner Name>













Peer Reviewer*<Name>












Safety<Name - if invited>












Software<Name - if invited>












ESG / Systems<Name - if invited>












EPDT / CSE<Name - if invited>












Hardware<Name - if invited>












Test<Name - if invited>












RoleAdd more if necessaryDateAttendanceApproval?










































P.S.:Yes indicates adherence














No indicates non-adherence, reviewer shall provide suitable comments at the end of this document for each point.














NA indicates not applicable














Sheet 3: Template Change Log

RevChangeAuthor
01.00.05Added lesson learned #3.5MDK
01.00.06Added lesson learned #3.6, 3.7 - Structure and writing of NVM in mfiles and models.MDK
02.00.00Combined ESG and Systems into one, compatible with Data_Management 2.13.0 of CreateDD and VerifyDD.K. Derry
02.01.00Added: Does FDD.DesignASIL match requirements?
Added: Was webview model created without requirements highlighted?
Removed: Redundant row in Data Dictionary section.
Formatting: Column C now consistently center-justified.
K. Derry
02.02.00Added: Are all data types represented by released Data_Management classes?
Removed: Are all runnables defined? Rationale: Automated tools checking.
Removed: Does the Component shortname match data dictionary FDD metadata?
Removed: "Data store name must resolve to Simulink signal object"
Edited: Model Advisor report should now be left unzipped.
K. Derry