Difference between revisions of "User:Pascal/Collections/Deploy Deliverable D23"

From Event-B
Jump to navigationJump to search
imported>Pascal
imported>Pascal
Line 1: Line 1:
 
== Introduction ==
 
== 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 [http://bscw.cs.ncl.ac.uk/bscw/bscw.cgi/d103646/D23_Writing_Plan.pdf writing plan] for this document.
+
The purpose of this page is give a base for the DEPLOY Deliverable D23 (Model Construction and Analysis Tool II).
  
This template takes into consideration the review feedback for the DEPLOY Deliverable D6 (Model Construction and Analysis Tool I).
+
The [http://bscw.cs.ncl.ac.uk/bscw/bscw.cgi/d103646/D23_Writing_Plan.pdf D23 Writing Plan] gives a table of contents for this document.
  
 
== Template ==
 
== 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 the WP9 partners during the passed year.  
+
For each item covered in this document, a wiki page shall be created (see below) to provide a description of work and describe the role of the WP9 partners during the passed year.
 +
 
 +
The purpose of the template is to provide a common structure for all of these pages. It takes into consideration the review feedback for the DEPLOY Deliverable D6 (Model Construction and Analysis Tool I).
  
 
=== Overview ===
 
=== Overview ===
Line 42: Line 44:
 
* "plug-in" shall be preferred to "plugin".
 
* "plug-in" shall be preferred to "plugin".
  
== Example ==
+
== Contents ==

Revision as of 15:30, 2 November 2009

Introduction

The purpose of this page is give a base for the DEPLOY Deliverable D23 (Model Construction and Analysis Tool II).

The D23 Writing Plan gives a table of contents for this document.

Template

For each item covered in this document, a wiki page shall be created (see below) to provide a description of work and describe the role of the WP9 partners during the passed year.

The purpose of the template is to provide a common structure for all of these pages. It takes into consideration the review feedback for the DEPLOY Deliverable D6 (Model Construction and Analysis Tool I).

Overview

This first paragraph shall identify the involved partners and give an overview of the contribution. More precisely, it shall provide answers to the following questions:

  • What are the common denominations?
  • Is it a new feature or an improvement?
  • What are the main purposes?
  • Who is in charge of the tasks?
  • Who is involved among the academic and industrial partners? Who is involved as developer? Who is involved as user?

Motivations

This paragraph shall first indicate the state before the work and highlight the encountered problems. Then, it shall express the motivation for each tool extension and improvement (requirements of industrial partners).

Design Decisions

Available Documentation

This paragraph shall give pointers to the available wiki pages or related publications. These documents may contain:

  • Requirements.
  • Technical details (specifications).
  • Teaching materials (tutorials).
  • User's guides.

A distinction shall be made between these categories and between documentation for developpers and documentation for end-users.

Corrective and Evolutive Maintenance

This paragraph describes how bugs and feature requests are addressed.

Planning

This paragraph shall give a timeline. More precisely, it shall give the current status of the new features (still under development, available prototype, available since release M.m), the current version of the features, describe the tasks which have already been completed and announce planned further work and deadlines (release versions of the Rodin platform).

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".

Contents