Template:REQ: Difference between revisions
From Calidus HUB
No edit summary |
m (Categorisation of document pages) |
||
(6 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<div class="noprint"> | <div class="noprint"> | ||
{{#vardefine:Client|The Client}} | {{#vardefine:Client|The Supimix Client Code}} | ||
{{#vardefine:System| | {{#vardefine:ClientName|The Client Name}} | ||
{{#vardefine:System|''CALIDUS'' Mobile/WMS/TMS/ePOD}} | |||
{{#vardefine:SystemCode|WCS/WMS/TMS/EPOD/MCS/Portal}} | |||
{{#vardefine:Doc_Title|Description}} | {{#vardefine:Doc_Title|Description}} | ||
{{#vardefine:Version|0.1}} | {{#vardefine:Version|0.1}} | ||
{{#vardefine:Date|16th June 2011}} | {{#vardefine:Date|16th June 2011}} | ||
{{#vardefine:Reference|Supimix References}} | {{#vardefine:Reference|Supimix References}} | ||
{{#vardefine:Year|Year}} | |||
</div> | </div> | ||
{{Doc_Title | {{Doc_Title | ||
|Client={{#var: | |Client={{#var:ClientName}} | ||
|System={{#var:System}} | |System={{#var:System}} | ||
|Title={{#var:Doc_Title}} | |Title={{#var:Doc_Title}} | ||
|Reference= | |Reference=REQ {{#var:Reference}} | ||
|Version={{#var:Version}} | |Version={{#var:Version}} | ||
|Date={{#var:Date}} | |Date={{#var:Date}} | ||
|Year={{#var:Year}} | |||
}} | }} | ||
Line 23: | Line 27: | ||
== Objective == | == Objective == | ||
The primary purpose of this document is to document the requirements gathered from {{#var: | The primary purpose of this document is to document the requirements gathered from {{#var:ClientName}}, at X, Y, Z | ||
<!-- List all amendments to the requirements here, and reference in final section, e.g. The document also encompasses the follow-up meeting held at X, with Y and Z attending, where the requirements were modified. See the minutes of the meeting referenced as item X in appendix B --> | <!-- List all amendments to the requirements here, and reference in final section, e.g. The document also encompasses the follow-up meeting held at X, with Y and Z attending, where the requirements were modified. See the minutes of the meeting referenced as item X in appendix B --> | ||
This document has been written in a manner such that it can be approved by non-technical representatives of {{#var: | This document has been written in a manner such that it can be approved by non-technical representatives of {{#var:ClientName}} whilst also being of sufficient detail to allow the Functional or Technical Specification phase for this area to begin. | ||
== Scope and Limitations == | == Scope and Limitations == | ||
This document is based on the documentation provided by {{#var: | This document is based on the documentation provided by {{#var:ClientName}}, as referred to in the appendices, as well as information gleaned from site visits and workshops with {{#var:ClientName}}. | ||
<!-- ANY scope or limitations, bulleted. --> | <!-- ANY scope or limitations, bulleted. --> | ||
*The changes will be made in the latest version | *The changes will be made in the latest version of the {{#var:System}} system. | ||
<!-- ANY other systems? e.g. does this link to TTM, WMS, 414, 770, etc? --> | |||
{{ #vardefine: SCR | 0 }} | |||
<!-- NEW PAGE --> | <!-- NEW PAGE --> | ||
= Client Requirements = | = Client Requirements = | ||
Listed below are the proposed processes that will be followed by the | Listed below are the proposed processes that will be followed by the operatives using {{#var:System}}. Also shown are the SCRs required for this to be achieved. | ||
<The current operational process flow has been described in documents produced by X of Y.> | <The current operational process flow has been described in documents produced by X of Y.> | ||
Line 54: | Line 59: | ||
<!-- A description of the operational flow for this functional area, as it will be. Reference any operational flow documents produced for the way it is now. | <!-- A description of the operational flow for this functional area, as it will be. Reference any operational flow documents produced for the way it is now. | ||
A functional area isn’t ‘Warehousing’, it’s a sub-section of warehousing. For example, Receipt, Picking, Packing, etc. | A functional area isn’t ‘Warehousing’, it’s a sub-section of warehousing. For example, Receipt, Picking, Packing, etc. | ||
It is important to keep the flow of the text, so that it can be easily understood. So, if an SCR has been identified, reference the SCR here, in bold. Keep the description snappy. Also, include a cross-reference to the SCR numbers in the table at the end of the document, and include the supimix number from the Reference Docproperty. When you identify a gap, | It is important to keep the flow of the text, so that it can be easily understood. So, if an SCR has been identified, reference the SCR here, in bold. Keep the description snappy. Also, include a cross-reference to the SCR numbers in the table at the end of the document, and include the supimix number from the Reference Docproperty. When you identify a gap, use the template 'SCR' as follows: | ||
{{SCR | |||
|Reference={{#var:Reference}} | |||
|SCRNo={{ #vardefineecho: SCR | {{ #expr: {{ #var: SCR }} + 1 }} }} | |||
|Definition=The description of the change required | |||
}} | |||
Then, add the line in the table in appendix A with: | |||
{{REQ_SCR_Line | |||
|SCR={{ #vardefineecho: SCR | {{ #expr: {{ #var: SCR }} + 1 }} }} | |||
|System=System Affected | |||
|Area=Area Affected | |||
|Description=Description of change | |||
|Estimate=Cost | |||
|Notes=Any notes, numerically listed | |||
}} | |||
There may be many SCRs for each section. Keep numbering and referencing them. Keep the table in Appendix A updated as you go along. If you re-order the SCR’s in the table, or insert new ones, don’t forget to update the document references. --> | There may be many SCRs for each section. Keep numbering and referencing them. Keep the table in Appendix A updated as you go along. If you re-order the SCR’s in the table, or insert new ones, don’t forget to update the document references. --> | ||
Line 106: | Line 124: | ||
|Rev1Title=Rev1 Title | |Rev1Title=Rev1 Title | ||
}}</div> | }}</div> | ||
[[Category: | [[Category:{{#var:Client}} REQ]] | ||
[[Category:{{#var:SystemCode}}]] |