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

Return to the regular view of this page.

Component Design

1: SF012A_HysCmp
2: SF012A_HysCmp_ind
3: SF012A_HysCmp_Peer Review Checklist Design
4: SF012A_HysCmps

Component Design

Component Documentation

1 - SF012A_HysCmp

document1

2 - SF012A_HysCmp_ind

Page 1
Page 2
Page 3
Page 4
Page 5
Page 6
Page 7
Page 8
Page 9
Page 10
Page 11
Page 12
Page 13
Page 14
Page 15
Page 16
Page 17
Page 18
Page 19

3 - SF012A_HysCmp_Peer Review Checklist Design

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 Owner	Confirm that requirements are reviewed and approved PRIOR to the FDP peer review
	Function Owner	Start with latest version of the template for any "first reviews" - Continue to use existing temmplate for re-reviews
	Function Owner	Provide the functional design package (changed documents) to the invited attendees 1-2 working days in advance of review
	Function Owner	Notify the assigned peer reviewer and make sure they are prepared to do their function in the meeting
	Function Owner	Identify necessary attendance and invite to meeting
	Function Owner	Complete the "Author" column information for sections 1 through 3 prior to the review
	Function Owner	Complete the attendance invitation list in section 5
	Function Owner	For Re-reviews only: Complete the column "remarks by author" to identify actions taken to address items found in earlier reviews.

DURING MEETING
	Function Owner	Present document changes to the review team
	Peer Reviewer	Capture attendance of the review
	Peer Reviewer	Capture actions and issues in section 4. Identify issue summary, Document type, Reference (Requirement ID, section number, etc), Defect Type and indicate status as "OPEN"

POST MEETING
	Function Owner	Follow up on all "open" items. Update "Summary of Resolution" to indicate what was done or decided.
	Function Owner	Schedule follow up review OR review open items with peer reviewer and obtain agreement to close
	Peer Reviewer	Close 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.00.00

Product Name

Electric Power Steering

Electrical Arch.

Review Scope

Defect Type

Numbers

Yes

Closed

Function ID

SF012A_HysCmp

Initial Baseline in EA4

Requirement

Rejected

FDD

Long Name

Hysteresis Compensation

Interface

Open

Model

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

Effort

Design

FMEA

Author

KPIT Offshore

Review Effort(Hrs.)

0.20

Standards

*.m File

Corr+Verf effort(Hrs.)

0.10

Documentation

Cal Process

Total Effort (Hrs.)

Others

Total

Checklist No.

Description of Check

Author: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. Author

Author: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. Reviewer

Author: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewer

Author: Defect type to be selected. Defect Type

Author: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By Author

Author: Data in this column shall be filled by reviewer after checking whether the rework is completed. Status

Section 1: Data Dictionary

Is Filename of Data Dictionary in correct format?

Yes

Is the FDD.Version property correctly updated?

Yes

Is the Data Dictionary Verification report error free?

Errors are due to missing signal names in the nexteer signal list and known issues in the tool

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

No Baseline requirements available

Are all runnables defined?

Yes

Do runnables have the correct time step?

Yes

Do server runnables correctly define arguments?

No Server runnables

Are all clients defined?

Yes

Do client definitions match the corresponding server runnable?

Yes

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

Yes

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

No Baseline requirements available

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

Yes

Do all calibrations have correct values for all metadata?

Yes

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

Yes

Is NVM defined in the appropriate number of blocks?

No NVM defined

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

Yes

Are all dependent constants and calibrations included in one file?

Yes

Section 2: Model

Author: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. Author

Author: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. Reviewer

Author: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewer

Author: Defect type to be selected. Defect Type

Author: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By Author

Author: Data in this column shall be filled by reviewer after checking whether the rework is completed.

Is filename of model in correct format?

Yes

Is Top level of model annotated with Requirements Baseline?

No Baseline requirements available

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

Yes

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

Yes

Does the Component shortname match data dictionary FDD metadata?

Yes

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

Yes

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

Yes

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

Yes

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

Yes

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

Yes

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

Yes

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

Yes

Do all Memory Store blocks for PIM and Display Variables have the "Data store name must resolve to Simulink signal object" setting checked to true?

Yes

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

No NTCs

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

No non-zero intialization of PIMs in the model

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

No NVM defined

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

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

Yes

Section 3: Requirements Linking

Author: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. Author

Author: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. Reviewer

Author: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewer

Author: Defect type to be selected. Defect Type

Author: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By Author

Author: Data in this column shall be filled by reviewer after checking whether the rework is completed.

Are all requirements links of the format <FDDNumber>_<ObjectID>?

No baseline requirements available

Does requirements HTML report reference only the DOORS module of this component for all links in the design?

No baseline requirements available

Are linked blocks linked to the correct requirements(s)? (watch for problems due to copy/pasted blocks)

No baseline requirements available

Is the list of unlinked blocks acceptable?

No baseline requirements available

Section 4: Model Advisor

Author: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. Author

Author: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. Reviewer

Author: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewer

Author: Defect type to be selected. Defect Type

Author: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By Author

Author: Data in this column shall be filled by reviewer after checking whether the rework is completed.

Was Model Advisor run with the correct configuration settings?

Yes

Is the Model Advisor rerport free from "Fails".

Fail' due to Simscape licensce error. This fail can be ignored as we don’t use Simscape

Are Model Advisor report "Warnings" acceptable?

Yes

Section 5: Delivery Package

Author: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. Author

Author: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. Reviewer

Author: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewer

Author: Defect type to be selected. Defect Type

Author: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By Author

Author: Data in this column shall be filled by reviewer after checking whether the rework is completed.

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

Yes

Does Doc folder contain a zipped HTML webview model?

Yes

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

Requirement traceability report does not exists as requirement linking is not created due to non availability of baseline requirements

Section 6: Other Issus/Actions Identified

Document

Reference

Summary of resolution

Author: Defect type to be selected. Defect Type

Author: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By Author

Author: Data in this column shall be filled by reviewer after checking whether the rework is completed.

6.1

6.2

6.3

6.4

6.5

6.6

6.7

6.8

6.9

6.10

6.11

6.12

6.13

6.14

6.15

6.16

6.17

6.18

6.19

6.20

6.21

6.22

6.23

6.24

6.25

Section 7: APPROVALS

Role

First Review

Date

Attendance

Approval?

Function Owner*

1/6/2016

Peer Reviewer*

Kevin Derry

Yes

Safety

Software

ESG / Systems

EPDT / CSE

Hardware

Test

Role

Second Review (if required)

Date

Attendance

Approval?

Function Owner*

Peer Reviewer*

<Name>

Safety

Software

ESG / Systems

EPDT / CSE

Hardware

Test

Role

Third Review (if required)

Date

Attendance

Approval?

Function Owner*

Peer Reviewer*

<Name>

Safety

Software

ESG / Systems

EPDT / CSE

Hardware

Test

Role

Fourth Review (if required)

Date

Attendance

Approval?

Function Owner*

Peer Reviewer*

<Name>

Safety

Software

ESG / Systems

EPDT / CSE

Hardware

Test

Role

Add more if necessary

Date

Attendance

Approval?

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

Rev	Change	Author
01.00.05	Added lesson learned #3.5	MDK
01.00.06	Added lesson learned #3.6, 3.7 - Structure and writing of NVM in mfiles and models.	MDK
02.00.00	Combined ESG and Systems into one, compatible with Data_Management 2.13.0 of CreateDD and VerifyDD.	K. Derry