| Requirement Pattern Documents Characteristics | Description | This pattern expresses the need of stating the characteristics of the documents generated during the system implementation project (format, naming conventions, language, ...). | |
| Comments | ---- | ||
| Pattern goal | Stating the format rules of the system implementation project and system documents | ||
| Author | Cristina Palomares, Samuel Renault, Carme Quer, Cindy Guerlain | ||
| Sources (0..*) |
| ||
| Keywords (0..*) | Documentation, Documentation characteristics, Documentation features, Documentation language, Electronic format, Hard copy, Metadata, Naming conventions, Paper | ||
| Dependencies (0..*) | IMPLIES ---- | ||
| Requirement Form Heterogeneous Documents Characteristics | Description | This form expresses the need of stating different characteristics (language, electronic format, naming conventions, metadata and paper format) for different documents generated during the system implementation project. | |
| Comments | Fixed part application: (1); Extended parts application:-Documents language (*) -Electronic documents format (*) -Electronic documents naming (*) -Documents metadata (*) -Hard copy documents format (*); Parameter values constraints: -documentTypes DisjointValues (Documents language) -documentTypes (Documents language) isIncludedIn documentTypes (Fixed Part) -documentTypes DisjointValues (Electronic documents format) -documentTypes (Electronic documents format) isIncludedIn documentTypes (Fixed Part) -documentTypes DisjointValues (Electronic documents naming) -documentTypes (Electronic documents naming) isIncludedIn documentTypes (Fixed Part) -documentTypes DisjointValues (Documents metadata) -documentTypes (Documents metadata) isIncludedIn documentTypes (Fixed Part) -documentTypes DisjointValues (Hard copy documents format) -documentTypes (Hard copy documents format) isIncludedIn documentTypes (Fixed Part) | ||
| Version date | 2012-05-23 14:31:52.671 | ||
| Author | Cristina Palomares, Samuel Renault, Carme Quer, Cindy Guerlain | ||
| Sources (0..*) |
| ||
| Fixed Part | Question text | ---- | Form text | The supplier shall deliver documents corresponding to %documentTypes% that follow some specific characteristics. |
| 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 Documents language | Question text | ---- | Form text | The supplier shall provide a copy of each document corresponding to %documentTypes% in %docLanguages% languages. |
| Parameter | Metric | ||
| docLanguages: is a non-empty set of natural languages | NaturalLanguages: NaturalLanguages = Set(NaturalLanguage) NaturalLanguage= Domain(ISO language definition) | ||
| 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 Documents metadata | Question text | ---- | Form text | The supplier shall include in each document corresponding to %documentTypes% the %docMetaData%. |
| Parameter | Metric | ||
| docMetadata: is a non-empty set of the different properties of a document that can be part of its metadata | DocMetadata: DocMetadata = Set (DocMetadataType) DocMetadataType = Domain (date of last update, page number, number of total pages, versions and responsible of each one, 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.) | ||
| Extended Part Electronic documents format | Question text | ---- | Form text | The supplier shall provide an electronic copy corresponding to %documentTypes% in %electronicFormats% format of each document. |
| Parameter | Metric | ||
| electronicFormats: is a non-empty set of the different extensions for electronic formats | ElectronicFormats: ElectronicFormats = Set(ElectronicFormat) ElectronicFormat = Domain (pdf, jpg, xls, doc, odt 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.) | ||
| Extended Part Electronic documents naming | Question text | ---- | Form text | The supplier shall name electronic documents corresponding to %documentTypes% as a concatenation of the following %docNameElements% elements. |
| Parameter | Metric | ||
| docNameElements: is a non-empty order set of the different properties of a document that can be part of its name | DocNameElements: DocNameElements= OrderSet(DocNameElement) DocNameElement = Domain(project name, document name, version, 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.) | ||
| Extended Part Hard copy documents format | Question text | ---- | Form text | The supplier shall provide a printed copy of documents corresponding to %documentTypes% in %paperFormat% format of each document. |
| Parameter | Metric | ||
| paperFormat: represents one of the different standard paper formats | PaperFormat: PaperFormat = Domain(A0, A1, A3, A2, 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.) | ||
| Requirement Form Homogeneous Documents Characteristics | Description | This form expresses the need of stating the characteristics (language, electronic format, naming conventions, metadata and paper format) of all documents generated during the system implementation project. | |
| Comments | Fixed part application: (1); Extended parts application: -Documents language (0..1) -Electronic documents format (0..1) -Electronic documents naming (0..1) -Documents metadata (0..1) -Hard copy documents format (0..1) | ||
| Version date | 2012-05-23 14:31:52.64 | ||
| Author | Cristina Palomares, Samuel Renault, Carme Quer, Cindy Guerlain | ||
| Sources (0..*) |
| ||
| Fixed Part | Question text | ---- | Form text | The supplier shall deliver documents that follow the same specific characteristics. |
| Extended Part Documents language | Question text | ---- | Form text | The supplier shall provide a copy of each document in %docLanguages% languages. |
| Parameter | Metric | ||
| docLanguages: is a non-empty set of natural languages | NaturalLanguages: NaturalLanguages = Set(NaturalLanguage) NaturalLanguage= Domain(ISO language definition) | ||
| Extended Part Documents metadata | Question text | ---- | Form text | The supplier shall include in each document the %docMetadata%. |
| Parameter | Metric | ||
| docMetadata: is a non-empty set of the different properties of a document that can be part of its metadata | DocMetadata: DocMetadata = Set (DocMetadataType) DocMetadataType = Domain (date of last update, page number, number of total pages, versions and responsible of each one, etc.) | ||
| Extended Part Electronic documents format | Question text | ---- | Form text | The supplier shall provide an electronic copy in %electronicFormats% format of each document. |
| Parameter | Metric | ||
| electronicFormats: is a non-empty set of the different extensions for electronic formats | ElectronicFormats: ElectronicFormats = Set(ElectronicFormat) ElectronicFormat = Domain (pdf, jpg, xls, doc, odt etc.) | ||
| Extended Part Electronic documents naming | Question text | ---- | Form text | The supplier shall name electronic documents as a concatenation of the following %docNameElements% elements. |
| Parameter | Metric | ||
| docNameElements: is a non-empty order set of the different properties of a document that can be part of its name | DocNameElements: DocNameElements= OrderSet(DocNameElement) DocNameElement = Domain(project name, document name, version, etc.) | ||
| Extended Part Hard copy documents format | Question text | ---- | Form text | The supplier shall provide a printed copy in %paperFormat% format of each document. |
| Parameter | Metric | ||
| paperFormat: represents one of the different standard paper formats | PaperFormat: PaperFormat = Domain(A0, A1, A3, A2, etc.) | ||