-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathDefault.ini
626 lines (591 loc) · 30.4 KB
/
Default.ini
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
[Default]
Company=Synopse
Product=SynProduct
ProductPath=SynProduct
ReleaseName=SynProduct Release
DefaultAuthor=Arnaud Bouchez
DefaultAuthorFunction=Software Engineer,Develop software
SADModules=Main
; will update [SAD] Source=.. value
SRSOwnORDER=No
; $SRSORDER$=DI or SRS (if DI can be split into SRS sub-items)
DefaultPath=\Dev\
; root path for all files involved in this project
; the commits will be stored in $DefaultPath$\$ReleaseName$.dvs
DocumentsPath=Documents
; sub directory containing Documents, as $DocumentsPath$\$ProductPath$\$ReleaseName$
BackupPathLocal=\-=- Backup -=-\Synopse
; path of the backup directory
;BackupPathDistant=\\DistantServer\Backup\Synopse
; path of an optional distant backup directory
[Params]
; default values for commits text in .dvs root
LastCommit=
ReleaseName=$ReleaseName$
Company=$Company$
Product=$Product$
ProductPath=$ProductPath$
DocumentsPath=Documents
DefaultAuthor=$DefaultAuthor$
IgnorePath=CSV,BACKUP,GG
IgnoreFile=.~
FilterDefault=.pas.dfm.bpg.cfg.dpr.inc.dof.msg.bat.lng.res.rc.ini.bmp.png.css.emf.jpg.gif.ico.dpk.dcr.nsi.so.xml.dat.c.h.cpp.hpp.mod.php
DefaultPath=$DefaultPath$
SCR=$DocumentsPath$\$ProductPath$\Common\$Product$.scr
; the .scr file contains the tracker entries and their associated investigation and implementation text (to be moved into .pro according to the DI) - it's an evolving file, not fixed to a special release (therefore it's in the \Common directory, not \$ReleaseName$
MAN=$DocumentsPath$\$ProductPath$\Common\$Product$.man
; the .man file contains the manuals (user manual and reference manual, e.g.) - it's an evolving file, not fixed to a special release (therefore it's in the \Common directory, not \$ReleaseName$) but it may content some links to pictures in the releases directories
PRO=$DocumentsPath$\$ProductPath$\$ReleaseName$\$ReleaseName$.pro
; the .pro file contains all the release documentation (DI,SRS,SDD,SAD,Test,VV,SCRS)
LastUpdate=
; Update*=Display Name;Path;[FilterDefault;][*.???;][*.???;][*.???]
Update0=$ProductPath$ Project source;$ProductPath$;FilterDefault
Update1=$Product$ Documentation;$DocumentsPath$\$ProductPath$\Common;*.*
Update2=$ReleaseName$ Documentation;$DocumentsPath$\$ProductPath$\$ReleaseName$;*.*
Update3=
Update4=
Update5=
Update6=
Update7=
Update8=
Update9=
LastBackup=
BackupDir0=Local backup,0123456789,$BackupPathLocal$
BackupDir1=Distant backup,0123456789,$BackupPathDistant$
BackupDir2=
BackupDir3=
[People]
;Name=Function,Function details
$DefaultAuthor$=$DefaultAuthorFunction$
[Project]
Name=$ReleaseName$
Company=$Company$
ReleaseVersion=
ReleaseDate=
Manager=$DefaultAuthor$
MainSection=DI
; so we first check for [DI] and [DILayout]
NoRiskDisplay=Not implemented
DestinationDir=
; path to store all created .doc (not to be inside versioning tree)
OldWordOpen=No
; if OldWordOpen=Yes, Conversion is made visible on the screen (compatible with some Word 2000 installations)
DefLang=1033
Logo=SynopseLogo.emf
; this picture will be displayed top of every document front page
HeaderColWidth=22,37,22,19
; page header columns width, according to Manager=The Manager's name
{\b WARNING:} THE ATTACHED DOCUMENTS DESCRIBE CONFIDENTIAL INFORMATION OF $COMPANY$.
ACCESS SHOULD BE RESTRICTED TO ONLY THOSE INDIVIDUALS WHO ARE FULL-TIME EMPLOYEES OF $COMPANY$ OR COMPANIES WHICH HAVE SIGNED A CONFIDENTIALITY AGREEMENT WITH $COMPANY$ AND HAVE A LEGITIMATE REASON TO KNOW THE CONTENTS OF THESE DOCUMENTS.
[Pictures]
; here are stored the Pictures properties, as PictureFileName=WIDTHxHEIGHT PERCENT%,Caption
SynopseLogo.emf=620x124 25%,Official Synopse Logo
[DI]
Owner=DI
Order=DI
Name=Design Input Product Specifications
ItemName=DI
DisplayName=Design Input
Purpose=Create high level description of software specifications
PreparedBy=$DefaultAuthor$
ReviewedBy=
ApprovedBy=
; Revision* multiple revision Table: ignored values are taken from current, older below
Revision=
RevisionDescription=Initial Version
RevisionDate=
; [DILayout] list the global DI outline (lines beginning with : are titles)
; [DI-*] details all items
DefaultPreparedBy=$DefaultAuthor$
; all [DI-*] PreparedBy= default name
DocumentFrontPage=ProjectDetails,Warning,PeopleDetails,RevisionDetails,AddPurpose
;SubDocFrontPage=Warning,PeopleDetails
:System Specifications
; special lines begin with
; : for titles (no Name=Value pairs after a :title)
; :# Title for a later reference as @#@ (":1 Title" then @1@)
; - for a list item
; ! for pascal source
; !! for modified pascal source line
; & for c c++ source
; &! for modified c c++ source line
; # for c# source
; #! for modified c# source line
; $ for text file (fixed-width font)
; $! for modified text file line (fixed-width font)
; %filename.jpg [640x480 85%] for images jpg/bmp/png/emf - see [Pictures]
; %%FirmwareBoot for diagram images, i.e. not listed in [Pictures] but created with \graph FirmwareBoot ...
; |%30%40%30 then |Col 1|Col 2|Col 3 for every row, ending with |% for columns
; |%=-30%40%30 -> =:no indent -:no border
; =[SectionName] to inline the [SectionName] content at this place
; text can be formated as rtf (with \b \i { } e.g.) - each new text paragraph will be ended with \par
; {} can be used for a \par alone (void lines are just ignored)
; you can link to another item with @SectionName@ (@DI-4.1@ e.g) or @DocName@ (@SRS@) or @PeopleName@ (@Arnaud Bouchez@) or either @%Picture.png@
; you can embedd a picture within a table cell e.g., by using @=%picture.png@ - in this case, this is not a "button"
; internet links will be handled as hyperlink, with @http://synopse.info
; in the [SDD-*] sections, specify @Module\filename.pas@ for each file name, @!Module\filename.pas@ for filename modified or @!procedurename!Module\filename.pas@ in order to specify the procedure name. The corresponding units (and procedures) will be highlited in the [SAD] document. Just click on the button to use the Object Browser window.
; some special lines commands can be entered:
; \page to force a new page
; \landscape to change the page orientation to landscape
; \portrait to change the page orientation to portrait
; \footer blabla to change the footer text
; \Layout to add a list with all DILayout titles
; \LayoutPage idem + associated pages in the document
; \risk to add the Risk Assessment Scale table
; \Source (for [SAD] section) to add the list of the Source=.. modules
; \SourcePage idem + associated pages in the document
; \include filename.ext ext will be used to append !&#$ left
; \graph UniqueImageName [Title] then following lines either .dot normal text, either "\From Text\To Text[\Label between both]" - use F12 to have the dialog
; \TableSoftwareChanges or \TableTraceabilityMatrix for SCRS
; \TableNewFeatures or \TableBugFixes or \TableTests[=October 16, 2008] for Release Notes
; \TableDI=6.3.1.2,6.3.1.3 for a table with all the supplied Design Inputs
; \TableDocuments[=DI,SRS,SDD,SAD] for a table with the supplied document details
; \Implements TableImplementsName #.# [Description][\DocumentName] (\Implements ISO 4.3 Software safety classification) in the text - points to the current document, or the specified DocumentName
; \TableImplements=TableImplementsName (\TableImplements=ISO) to create the list, sorted by ascending #.# numbers, with description if any and corresponding document
; =[SectionName] to include this section content at the current place
; in the [Test-*] sections, special auto-defined columns can be used with |Actions[|Expected Results] - manual tables can be used as usual (with |%..)
This document is intended to describe the Design Input Product Specifications.
: Definitions
{\b Added Value} - This level of achievement should be the target of the design team, because achieving this level of performance adds value to the product. However failure to achieve this level does not evoke additional management review.
{\b Must Have} - This level of achievement must be reached in the final design output. Because of possible negative financial impacts, if this level of performance is not achieved, management review will be triggered.
: Project Concept
: Purpose and Scope
This document focuses on the $Product$ hardware, firmware, and software applications.
The purpose of this Design Input Document is to detail the marketing requirements/product specifications for the improvement of the $Product$. The requirements and specifications found in this document are derived from customer market research, regulatory input and industry common practice.
: Concept Statement
...
: Expected Use Environment
...
: User Profile
...
: Requirement Exceptions
...
\page
:Software Design Input
The Software @DI@ items follow these main divisions:
\LayoutPage
[DILayout]
; lines beginning with : will be titles for general DI layout - the 'DI-' chars are added before numbers listed above
[RK]
; self-owned Risk Asssessment document
Owner=RK
Order=RK
ItemName=FMEA
DisplayName=Design FMEA
Name=Design FMEA File
DocName=Design FMEA File
; this DocName will be used for generating .DOC filename (instead of ItemName)
Purpose=List {\i Failure Modes and Effects Analysis} (FMEA)
PreparedBy=$DefaultAuthor$
ReviewedBy=
ApprovedBy=
Revision=
RevisionDate=
RevisionDescription=
; Revision* multiple revision Table: ignored values are taken from current, older below
DocumentFrontPage=ProjectDetails,Warning,PeopleDetails,RevisionDetails,AddPurpose
WriteRisk=Yes
; Write Risk assessment table summary after every RK item
WriteTableOfContent=Yes
; Write global Table Of Contents
TableOfContentsAtTheBeginning=Yes
; if the Table of Contents must be at the beginning (default=No=at the end of the file)
DocumentIndex=Pictures,Implements ISO=ISO 123456 requirements
; "Pictures" will create a table with all picture appearing in this document
; "Implements ISO=..." will create a table with all appearing "\Implements ISO 3.4" pages, with the specified item name
:Introduction
The @RK@ is a reference document used to list the {\i Failure Modes and Effects Analysis} (FMEA) identified for the $Product$.
The "{\i Failure modes and effects analysis}" (FMEA) is a procedure in operations management for analysis of potential failure modes within a system for classification by severity or determination of the effect of failures on the system. {\i Failure modes} are any errors or defects in a process, design, or item, especially those that affect the customer, and can be potential or actual. {\i Effects analysis} refers to studying the consequences of those failures.
In practice, a Risk Assessment team starts with a block diagram of a system. The team then considers what happens if each block of the diagram fails, and fills in a table in which failures are paired with their effects and an evaluation of the effects. The design of the system is then corrected, and the table adjusted until the system is known not to have unacceptable problems.
This @RK@ lists most FMEA items identified as possible Software Failure for the $Product$.
: Risk Assessment
In the following @RK@, a numerical Risk Assessment is given for every FMEA item, according to the {\i Risk Assessment Scale} table below.
A summary explanation is indicated, together with the names of those who made each evaluation.
\risk
: Responsibilities
- ...
:Fault Tree
\graph FTA $Product$ Fault Tree
$Product$\Operator Harm
$Product$\Patient Harm
\
[SRS]
Owner=DI
Order=$SRSORDER$
; Owner: [SRS-*] -> * reference; Order=SRS -> [SRS-*] have sub items
;Refers=RK
; Refers will add all [SRS-RK-*] items to the list, after the DI
Name=Software Requirements Specifications
ItemName=SWRS
Purpose=Interpret design inputs and specify software design features
PreparedBy=$DefaultAuthor$
ReviewedBy=
ApprovedBy=
Revision=
RevisionDate=
RevisionDescription=Initial version
; Revision* multiple revision Table: ignored values are taken from current, older below
;PreparedBy=.. ignored values are taken from current
; [SRS-*] sections describe each item ([DI] items + other items)
; [SRS-*] are displayed as they appear in the file
DocumentFrontPage=ProjectDetails,Warning,PeopleDetails,RevisionDetails,AddPurpose
WriteRisk=Yes
; Write Risk assessment table summary after every DI
WriteTableOfContent=Yes
; Write global Table Of Contents at the end of the file
TableOfContentsAtTheBeginning=Yes
; if the Table of Contents must be at the beginning (default=No=at the end of the file)
DocumentIndex=Pictures,Implements ISO=ISO 123456 requirements
:Introduction
: Purpose
This @SRS@ applies to the upgrade software for the $Product$.
It describes the software implementation of each design input as specified by the @DI@.
The sections of this document follow the @DI@ divisions:
\LayoutPage
;Then all items created from the @RK@ are listed:
;\referspage
For each Design Input item, the corresponding justification is specified, between parenthesis (SCR #65, e.g.).
Every @SRS@ item is named about the corresponding @DI@ item, or, in case the initial {\i Design Input} is too large and must be divided into some {\i SWRS} more precise items, an unique name is proposed.
: Risk Assessment
The Risk assessment indicated below was evaluated as a team work, based on the software solution proposed.
In the following @SRS@, a numerical Risk Assessment is given for every Design Input item, according to the {\i Risk Assessment Scale} table below.
A summary explanation is indicated, together with the names of those who made each evaluation.
\risk
: Responsibilities
...
[Risk]
Owner=SRS
Order=$SRSORDER$
; Owner: [Risk-*] -> * reference; Order=SRS -> [Test-*] have no sub items
Name=Software Implementation Risk Assessment
DocName=Risk Assessment
; this DocName will be used for generating .DOC filename (instead of ItemName)
Purpose=Perform a risk assessment of the SWRS implementation
PreparedBy=$DefaultAuthor$
ReviewedBy=
ApprovedBy=
Revision=
RevisionDate=
RevisionDescription=Initial Version
; Revision* multiple revision Table: ignored values are taken from current, older below
; rev.1 summary values are in [DI] Risk=Severity,Probability,Occurence,Comment
; [Risk-*] sections contain rev.2 details for each SRS, [Risk-SER-03] or [Risk-4.5.1] e.g.
DocumentFrontPage=ProjectDetails,Warning,PeopleDetails,RevisionDetails,AddPurpose,RiskTable
[SAD]
Owner=SRS
Order=$SRSORDER$
; Owner: [SAD-*] -> * reference; Order=SRS -> [SAD-*] have no sub items
Name=Software Architecture Design
Purpose=Describe the implications of each software requirement specification on all the affected software modules
PreparedBy=$DefaultAuthor$
ReviewedBy=
ApprovedBy=
Revision=
RevisionDescription=Initial Version
RevisionDate=
; Revision* multiple revision Table: ignored values are taken from current, older below
; [SAD-*] sections contain details for each SRS, [SAD-SER-03] or [SAD-DI-4.10.6] e.g.
; [SAD-*] are displayed as they appear in the [SRS-*] sections
DocumentFrontPage=ProjectDetails,Warning,PeopleDetails,RevisionDetails,AddPurpose
Source=$SADModules$
; presence of Source=.. adds global description for each SourceFile=.. and for @Module\filename.pas@ for the project (TProject.Parse: array of TSection - [SAD-Module] will get files from @Module\name.pas@, e.g.)
SourceSDD=SDD
; name of the [SDD] section to be parsed for modified files as @!Module\bidule.pas@
DefaultPath=$DefaultPath$\$ProductPath$
; global default directory to trim in the documentation, and used by default in [SAD-module] SourcePath=..
WriteTableOfContent=Yes
; Write global Table Of Contents at the end of the file
TableOfContentsAtTheBeginning=Yes
; if the Table of Contents must be at the beginning (default=No=at the end of the file)
DocumentIndex=Pictures,Source code File Names,Implements ISO=ISO 123456 requirements
; "Source code File Names" will create a table with all @source.code@ files within this document
:Introduction
: Purpose
This @SAD@ applies to the upgrade software for the $Product$.
It summarizes the implications of every software modification detailed in the @SDD@.
: Document layout
In a first part, this document presents the global Software architecture involved in this implementation, i.e.:
\Sourcepage
A second part then describes every @SRS@ item, according to the @DI@ main sections:
\LayoutPage
: First part: global Software architecture
... text below is occurate if Delphi parser is used
All the source code architecture is deeply analyzed. After a global introduction, each source code unit is detailed, with clear diagrams and tables showing the dependencies between the units, and the class hierarchy of the objects implemented within.
Note that every object or function modified by this release is highlighted in {\highlight7 yellow}, showing the corresponding {\i Design input} justifying this code modification, as listed in the second part.
: Second part: SWRS implications
For each SWRS item, links are made to the units sections of the first part, refering directly to the unit, class or function modified by the @SDD@.
: Responsibilities
...
[SAD-Source]
; this Section body is added as the introduction of the document first part
DisplayName=$Product$ Overview
:$Product$ Overview
...
: Document Scope
...
: Global Architecture layout
In the following sections, the $Product$ Software architecture is detailed as:
\SourcePage
[SDD]
Owner=SRS
Order=$SRSORDER$
; Owner: [SDD-*] -> * reference; Order=SRS -> [SDD-*] have no sub items
Name=Software Design Document
Purpose=Summarize the software DI implementation for QA review
PreparedBy=$DefaultAuthor$
ReviewedBy=
ApprovedBy=
Revision=
RevisionDate=
RevisionDescription=Initial Version
; Revision* multiple revision Table: ignored values are taken from current, older below
; [SDD-*] sections contain details for each SRS, [SDD-SER-03] or [SDD-DI-4.10.6] e.g.
; [SDD-*] are displayed as they appear in the [SRS-*] sections
DocumentFrontPage=ProjectDetails,Warning,PeopleDetails,RevisionDetails,AddPurpose
WriteTableOfContent=Yes
; Write global Table Of Contents at the end of the file
; Write global Table Of Contents at the end of the file
TableOfContentsAtTheBeginning=Yes
; if the Table of Contents must be at the beginning (default=No=at the end of the file)
DocumentIndex=Pictures,Source code File Names,Implements ISO=ISO 123456 requirements
:Introduction
: Purpose
This @SDD@ applies to the upgrade software for the $Product$.
It summarizes the software implementation of each design input as specified by the @DI@.
This document is divided into the main parts of the Software implementation:
\LayoutPage
Inside this sections, source code or User Interface modifications are detailed for every @SRS@ item.
: Responsibilities
...
[VV]
Owner=SRS
Order=$SRSORDER$
DisplayName=V&V Plan
DocName=V&V Plan
Name=Software Validation and Verification Plan
Purpose=Define the testing required for the updates to the $Product$ software along with the testing responsibilities
; just the message for 'Goal:' in the Software Verification Plan section
PreparedBy=$DefaultAuthor$
ReviewedBy=
ApprovedBy=
Revision=
RevisionDate=
RevisionDescription=Initial Version
; Revision* multiple revision Table: ignored values are taken from current, older below
DocumentFrontPage=ProjectDetails,Warning,PeopleDetails,RevisionDetails,AddPurpose
WriteTableOfContent=Yes
WriteSummaryOf=Test
; WriteSummaryOf=Test -> VV document will have 2 parts: [VV] body as introduction, then a list of all documents divided by [Test-*].Description=.., with [Test].Goal,[Test].DocName, and associated [SRS-*] (Owner=SRS) sections
:Introduction
: Purpose
This @VV@ applies to the upgrade software for the $Product$, implementing the Software part of the @DI@.
Its activities cover the modifications to the software as described in the @SRS@.
: Scope
The software supplied with the instrument is divided in the following parts, as specified by the @SAD@:
...
: Risks and Contingencies
Modifications to the software are required to resolve defects or add additional approved functionality. For each new version of software the risks must be assessed if the complete V&V plan is not followed. At a minimum the following must be documented: description of change, potential impact on software, minimal testing of software that must be performed and a summary of the testing. For additional risks see the @Risk@.
: Approach
The overall approach to testing will be functionality (black box) testing. Some test will be made with specific tools (software or debugger). The comprehensiveness of the testing will be evaluated by the completion of the test summary where the features are listed.
Any software defects will be reported to the developer and added to the bug tracking database. Defects will be reviewed and resolved based on the severity, occurrence and customer impact assigned to each defect.
: Item Pass/Fail criteria
{\i Pass/Fail} criteria will be determined based on the software requirements definition.
: Test results
Test results will be documented on the test protocol summary sheet. Any defects reported during testing will also be referenced on the test protocol summary.
: Test reports
Test Reports will be compiled from the Test Plan, Procedures and Test Results. The purposes of the Test Reports are to summarize the test protocols and results and draw a conclusion regarding the validation of the $Product$ to meet its design goals.
The Test Reports will contain the following information:
- Software Version Tested
- Summary of test results
- Summary of observations not included in this V&V plan.
- Recommendations
- List of the features to be tested showing the test procedure used to test each specification, version tested and the pass/fail determination.
- List of each test procedure showing the date of testing, tester, pass/fail determination and reference to any defect observed in testing.
- Software Problem Reports. List all defects reported during testing with the priority and open/closed status.
: Software Verification Plan
The Test Reports are divided into several document files, as listed in the {\i Software Verification Plan} below.
The {\i Software Verification Plan} layout follows the main sections of the @DI@:
\LayoutPage
: Responsibilities
This document is intended to be reviewed by QA team.
It is the responsibility of the Software V&V person or team to:
- Follow the software V&V protocols prepared in support of this V&V plan and to document the results.
- Complete all parts of a protocol in which a selection, such as Pass or Fail is requested or explain why a determination could not be made.
- Generate a V&V report noting compliance and deviance of the measured or observed from the expected and to submit it for review.
It is the responsibility of all Software Managers, Project Manager, or their designee to review and approve the software V&V plan and the software report.
\page
:Software Verification Plan
[Test]
Owner=SRS
Order=$SRSORDER$
; Owner: [Test-*] -> * reference; Order=Test -> [Test-*] have sub items
Name=Test protocols
ItemName=Test protocol
DocName=Test
Purpose=Describe all Test protocols with specific pass/fail criteria
PreparedBy=$DefaultAuthor$
ReviewedBy=
ApprovedBy=
Revision=
RevisionDate=
RevisionDescription=Initial Version
; Revision* multiple revision Table: ignored values are taken from current, older below
; [Test-*] sections contain details for each SRS, [Test-SER-03] or [Test-DI-4.7.6] e.g.
; [Test-*] are displayed as they appear in the [SRS-*] sections
; all individual Test documents can be created with the [Tests] section
; a global 'Test protocols.doc' can also be created, containing all Test reports in one big file, with corresponding options
;WriteRisk=Yes
; global 'Test protocols.doc' will contain corresponding Risk assessment
BodyIsTest=Yes
; so any [Test-*] will have a special format: | at the beginning of the line, like |Actions[|Expected Results[|Observations]] - same as a table, but with no |% before and after, and possibly missing |
; -> text between | has to use \line to between paragraph/lines
; -> a line with only | is a separator between tests: a new table will be printed
; -> if any value is entered in 'Expected Results', a Pass/Fail message will be added in Validation
DocumentFrontPage=ProjectDetails,Warning,PeopleDetails,RevisionDetails,AddPurpose
:Introduction
This @Test@ regroups all the {\i Test protocols} in an unique document. It may be convenient to have all the test procedures in the same file, for review purpose, e.g.
Every @SRS@ item is listed with an abstract of its implementation, then its specific protocol is written, following the main sections the @DI@:
\LayoutPage
;The numerical Risk evaluation, as stated in @Risk@, is written again for every Design Input item, according to the {\i Risk Assessment Scale} table shown on page 2.
[Tests]
Owner=SRS
Order=$SRSORDER$
Name=Test report
Purpose=Create all Tests protocols documents
; these Purpose= value will be used in the menu item hint
DocByDescription=Test
; -> individual documents divided by [Test-*].Description=.. can be created, with layout in [Tests]
; -> a last page is added, named 'Summary Sheet', taking executable versions and name in [SAD-*].Source= (SAD is TProject.ParseDoc)
SubDocFrontPage=TestDetails,RevisionDetails,AddPurpose
; additionnal front page values are taken from [Test-*].Requirements=.. and [Test-*].Notes=..
PreparedBy=$DefaultAuthor$
; // may be overwritten in [Test-*]
; body of this section is the last page summary sheet
{\ul{\b START TIME:}} {\f1 __________________ }{\ul{\b END TIME:}} {\f1 __________________}\line
{\ul{\b RELEVANT TESTING INFORMATION}}\line{\f1 _______________________________________________________________\line _______________________________________________________________\line _______________________________________________________________}\line
{\ul{\b DEVIATIONS FROM PROCEDURE}}\line {\f1 _______________________________________________________________\line _______________________________________________________________\line _______________________________________________________________}\line
{\ul{\b ATTACHMENTS LISTING}}
\par
\par
\par
{\b [ ] MEETS SPECIFICATIONS}
{\b [ ] DOES NOT MEET SPECIFICATIONS}\line
{\b PROCEDURE PERFORMED BY:\line{\f1 _____________________________________}}
{\b DATE:}{\f1 _____________}\line
{\b REVIEW AND APPROVAL BY:\line{\f1 _____________________________________}}
{\b DATE:}{\f1 _____________}
[SoftwareVersion]
:$Product$ (for $ReleaseName$)
|%23%18%15%44
|\b File Name|Date|Version|Description\b0
|...|...|...|...
|%
[KnownIssues]
|%15%85
|\b Request|Description\b0
|...|...
|%
[SoftwareHistory]
:$Product$
|%8%17%75
|\b Version|Date|Remarks\b0
|1.00|...|...
|%
[SCRS]
Owner=SRS
;Order=$SRSORDER$
; no Order= specified, so that the body of this [SCRS] document section will be written as plain text only
Name=Software Change Request Summary Form
Purpose=Cross-reference all software changes
ItemName=SCRS
PreparedBy=$DefaultAuthor$
ReviewedBy=
ApprovedBy=
Revision=
RevisionDate=
RevisionDescription=Initial version
; Revision* multiple revision Table: ignored values are taken from current, older below
YesNo=Yes
; this message will be used for 'Yes / No' value in table
DocumentFrontPage=ProjectDetails,Warning,PeopleDetails,RevisionDetails,AddPurpose,RiskTable
WriteTableOfContent=Yes
; Write global Table Of Contents at the end of the file
TitleFlat=Yes
; so the titles will be all numerical and hierachical (without any big sections)
Landscape=Yes
; full body is to be written as Landscape
:Software Changes
\TableSoftwareChanges
:Cross References
: Reference and Related Documents
\TableDocuments
: Traceability Matrix
\TableTraceabilityMatrix
:Package Content
=[SoftwareVersion]
:Known issues
=[KnownIssues]
[Release]
Owner=DI
;Order=DI
; no Order= specified, so that the body of this [Release] document section will be written as plain text only
Name=Release Notes
Purpose=Present all software modifications introduced in the current release
PreparedBy=$DefaultAuthor$
ReviewedBy=
ApprovedBy=
Revision=
RevisionDate=
RevisionDescription=Initial version
; Revision* multiple revision Table: ignored values are taken from current
DocumentFrontPage=ProjectDetails,Warning,PeopleDetails,RevisionDetails
WriteTableOfContent=Yes
; Write global Table Of Contents at the beginning of the file
TitleFlat=Yes
; so the titles will be all numerical and hierachical (without any big sections)
:Introduction
: Document Purpose
This @Release@ applies to the upgrade software for the $Product$, implementing the Software part of the @DI@.
It describes the software requirements and bug corrections involved in this release.
: Software Version
This release update the $Product$ software modules to the following versions.
=[SoftwareVersion]
: Hardware specifications
This release is compatible with the following hardware:
...
:Release Notes
: New features
New features implemented in this release are listed below.
\TableNewFeatures
; all DI with Request=SCR #123 will be listed here
: Bug fixes
The following bugs reported in earlier versions have been fixed.
\TableBugFixes
; all DI with SCR #65,Module 2.0+Other Module 3.0,Low will be listed here
: Installation Instructions
The Installation of this release follows the steps detailed in the {\i $Product$ User Manual}, and didn't change from previous version.
: Special Instructions for Use
As this release is mainly a bug fix, the instructions for use didn't change, and the former {\i $Product$ User Manual} can be seen as a valid reference document for the User.
: Open Issues
In a general manner, the User has to follow strictly the procedures detailed in the documentation shipped with the $Product$, and the corresponding software and hardware updates which may have been installed.
: Testing Status
The tests below were performed by strictly following the test protocols as stated by the @VV@, after having installed the release on a dedicated test computer.\line
\TableTests=...Date of test
All tests passed successfully. Therefore, this release should not prevent users from using features.
: Significant Faults
There are no significant remaining faults, which prevent using features.
See {\b Appendix B - Known Faults list} for the current open issues indentified in the release, and are planned to be corrected.
\landscape
:Appendices
: Appendix A - Software Revision History
=[SoftwareHistory]
: Appendix B - Known Faults List
The following table lists the significant bugs that were found in this release:
=[KnownIssues]
: Appendix C - Release Documentation Audit
The following table is a partial list of related documentation, including the current revision numbers and revision dates for all documentation applicable to this release.
\TableDocuments=DI,SRS,Risk,SAD,SDD,VV,SCRS
: Appendix D - ISO 123456 cross reference
Here is a table of the implementation of the {\i ISO 123456} standard in all the documentation:
\TableImplements=ISO
At the beginning of the @RK@, @SRS@, @SAD@ and @SDD@, a dedicated table will list all {\i ISO 123456} requirements implemented in this document, with its associated page.