User:Pascal/Collections/Deploy Deliverable D23: Difference between revisions
imported>Pascal |
imported>Pascal |
||
| Line 7: | Line 7: | ||
For each item covered in this document (see the writing plan), a section shall be created to provide a description of work and describe the role of partners during the passed year. | For each item covered in this document (see the writing plan), a section shall be created to provide a description of work and describe the role of partners during the passed year. | ||
More precisely, each section shall give an overview of the contribution, some | More precisely, each section shall give an overview of the contribution, some references, and some justifications for the decisions. | ||
=== Overview === | === Overview === | ||
| Line 18: | Line 18: | ||
=== Design Decisions === | === Design Decisions === | ||
=== | === Planning === | ||
This paragraph shall give the current version of the feature, describe the tasks which have already been completed and announce planned further work and deadlines (release versions of the Rodin platform). | |||
=== Available documentation === | |||
This paragraph shall give pointers to the available wiki pages or related publications. These documents may provide input requirements, technical details (specifications), teaching materials, or be user's guides. | |||
A distinction shall be made between documentation for developpers and documentation for end-users. | |||
=== Corrective and Evolutive Maintenance === | === Corrective and Evolutive Maintenance === | ||
This paragraph describes how bugs and feature requests are reviewed, | |||
== Formatting rules == | == Formatting rules == | ||
Revision as of 12:02, 2 November 2009
Introduction
The purpose of this page is to provide a template to define the common content for all sections of the DEPLOY Deliverable D23 (Model Construction and Analysis Tool II), as mentioned in the writing plan for this document.
This template takes into consideration the review feedback for the DEPLOY Deliverable D6 (Model Construction and Analysis Tool I).
Template
For each item covered in this document (see the writing plan), a section shall be created to provide a description of work and describe the role of partners during the passed year.
More precisely, each section shall give an overview of the contribution, some references, and some justifications for the decisions.
Overview
Motivations
This paragraph shall indicate the state before the work and the motivation for each tool extension and improvements.
In many cases the motivation will be to improve ease of use by industrial partners.
Design Decisions
Planning
This paragraph shall give the current version of the feature, describe the tasks which have already been completed and announce planned further work and deadlines (release versions of the Rodin platform).
Available documentation
This paragraph shall give pointers to the available wiki pages or related publications. These documents may provide input requirements, technical details (specifications), teaching materials, or be user's guides.
A distinction shall be made between documentation for developpers and documentation for end-users.
Corrective and Evolutive Maintenance
This paragraph describes how bugs and feature requests are reviewed,
Formatting rules
In order to homogeneize the contributions and to ensure consistent spelling the following formatting rules shall be enforced:
- See §4 of How to Edit Your Input File for LLNCS formatting rules.
- Contractions shall not be used (eg. write "does not" instead of "doesn't", "let us" instead of "let's", etc).
- "plug-in" shall be preferred to "plugin".
