| Requirement Pattern Delivered Documents | Description | This pattern expresses the need of defining what documents the supplier shall deliver as well as the details of the content of each document. | |
| Comments | ---- | ||
| Pattern goal | Defining the documents that shall be delivered | ||
| Author | Cristina Palomares, Samuel Renault, Carme Quer, Cindy Guerlain | ||
| Sources (0..*) |
| ||
| Keywords (0..*) | Dcoumentation content, Delivered document, Documentation aspects, Documents, Notation, Project deliverables, Traceability, Understandability, Validation | ||
| Dependencies (0..*) | IMPLIES ---- | ||
| Requirement Form Documentation | Description | This form expresses the need of defining the documents the supplier shall deliver as well as the content, notation, project assets, traceable elements, understandability by type of user and validation of each document. | |
| Comments | Fixed part application: (1); Extended parts application: -Document content (*) -Document content notation (*) -Traceability (*) -Understandability (*); Parameter values constraints: -documentType DisjointValues Document content -documentType(Document content) isIncludedIn documentTypes(FP) -documentType DisjointValues Document content notation -documentType(Document content notation) isIncludedIn documentTypes(FP) -documentType(Document content) DisjointValues documentType(Document content notation) -(documentTypes, documentContents1) DisjointValues Traceability -documentTypes (Traceability) isIncludedIn documentTypes (FP) -documentContents1 (Traceability) DisjointValues documentContents2 (Traceability) -(documentTypes, userProfiles) DisjointValues Understandabiltiy -documentTypes (Understandability) isIncludedIn documentTypes(FP) | ||
| Version date | 2012-05-23 14:31:52.764 | ||
| Author | Cristina Palomares, Samuel Renault, Carme Quer, Cindy Guerlain | ||
| Sources (0..*) |
| ||
| Fixed Part | Question text | ---- | Form text | The supplier shall deliver the %documentTypes% as result of the system implementation. |
| Parameter | Metric | ||
| documentTypes: is a non-empty set of type of document that can be generated in a system implementation project. | DocumentTypes: DocumentTypes = Set(DocumentType) DocumentType = Domain (user manual, meeting minutes, project report, analysis report, etc.) | ||
| Extended Part Document Content | Question text | ---- | Form text | The %documentType% shall include %documentContents%. |
| Parameter | Metric | ||
| documentContents: is a non-empty set of aspects that can appear in a delivered document | DocumentContents: DocumentContents = Set(DocumentContent) DocumentContent = String (eg, "descriptions of all new features", "descriptions of business workflows", "publishing workflows", "functional and nonfunctional requirements", "the architecture of the system to implement", "a glossary" etc.) | ||
| documentType: represents one of the possible documents that can be generated in a system implementation project. | DocumentType: DocumentType = Domain (user manual, meeting minutes, project report, analysis report, etc.) | ||
| Extended Part Document content notation | Question text | ---- | Form text | The %documentType% shall describe %documentContents% in %notationLanguages%. |
| Parameter | Metric | ||
| notationLanguages: is a non-empty set of the different notations that can be used to specify a document | NotationLanguages: NotationLanguages = Set(NotationLanguage) NotationLanguage = Domain(UML, i-star, narrative, etc.) | ||
| documentContents: is a non-empty set of aspects that can appear in a delivered document | DocumentContents: DocumentContents = Set(DocumentContent) DocumentContent = String (eg, "descriptions of all new features", "descriptions of business workflows", "publishing workflows", "functional and nonfunctional requirements", "the architecture of the system to implement", "a glossary" etc.) | ||
| documentType: represents one of the possible documents that can be generated in a system implementation project. | DocumentType: DocumentType = Domain (user manual, meeting minutes, project report, analysis report, etc.) | ||
| Extended Part Traceability | Question text | ---- | Form text | The %documentTypes% shall establish traceability between %documentContents1% and %documentContents2%. |
| Parameter | Metric | ||
| documentContents1: is a non-empty set of aspects that can appear in a delivered document | DocumentContents: DocumentContents = Set(DocumentContent) DocumentContent = String (eg, "descriptions of all new features", "descriptions of business workflows", "publishing workflows", "functional and nonfunctional requirements", "the architecture of the system to implement", "a glossary" etc.) | ||
| documentTypes: is a non-empty set of type of document that can be generated in a system implementation project. | DocumentTypes: DocumentTypes = Set(DocumentType) DocumentType = Domain (user manual, meeting minutes, project report, analysis report, etc.) | ||
| documentContents2: is a non-empty set of aspects that can appear in a delivered document | DocumentContents: DocumentContents = Set(DocumentContent) DocumentContent = String (eg, "descriptions of all new features", "descriptions of business workflows", "publishing workflows", "functional and nonfunctional requirements", "the architecture of the system to implement", "a glossary" etc.) | ||
| Extended Part Understandability | Question text | ---- | Form text | The %documentTypes% shall be understandable by %userProfiles%. |
| Parameter | Metric | ||
| userProfiles: is a non-empty set of user profiles | UserProfiles: UserProfiles = Set(UserProfile) UserProfile = Domain(Administrator, Author, User, ...) | ||
| documentTypes: is a non-empty set of type of document that can be generated in a system implementation project. | DocumentTypes: DocumentTypes = Set(DocumentType) DocumentType = Domain (user manual, meeting minutes, project report, analysis report, etc.) | ||