[cookbook's name] yPBL cookbook
by [author]
last update: __/__/__
28
Table of contents
Abstract
Keywords
Contributors
Releases
Introduction
The ingredients: Definitions and terminology
Ingredient 1
Recipes
Recipe1: A first recipe (e.g. a HelloWorld recipe)
Step1: short description of step 1
Recommended documentation
Reference 1
Feedback
1/7
yPBL methodology cookbook
http://homepages.laas.fr/eexposit/ypbl
[cookbook's name] yPBL cookbook
by [author]
last update: __/__/__
Abstract
Overall description of the cookbook and the intended recipes. The recipes give a global idea
of the solutions that will be developed within the cookbook. This abstract should be
submitted to review and approved by the reviewers before starting producing the reviews.
This approval phase will guarantee that the recipes are really satisfying the cookbook
readers expectations.
Keywords
Short list of main keywords. These keywords will help to semantically annotate the
cookbook when it will be publicly available from the yPBL collaborative living workspace.
2/7
yPBL methodology cookbook
http://homepages.laas.fr/eexposit/ypbl
[cookbook's name] yPBL cookbook
by [author]
last update: __/__/__
Contributors
Authors
Reviewers
….
….
….
…..
….
…..
The cookbooks are intended to be built collaboratively by a group of authors and reviewers before
making them publicly available from the yPBL living workspace:
●
●
●
Authors are in charge of proposing an abstract with the main goal of the cookbook and a
proposal of recipes and after approval from the reviewers, start producing the proposed recipes.
During the recipes production, the definitions (new knowledge) required to understand the
technologies or approaches used within the recipes need to be included in the ingredients
section or referenced from the reference section. The life-cycle of the cookbook needs to be
updated within the release table: for instance once a recipe is ready to review, the status needs
to be updated in order to allow reviewers to test it and provide feedback.
Reviewers are in charge of approving the cookbook recipes proposals and later reading and
following those recipes in order to validate if the results are the same after "cooking the recipes"
and if the definitions and instructions provided by the authors are correct and sufficient before
making the recipe publicly available. Reviewers can give feedback by opening issues (adding
comments) and following these issues when authors work on solving them. Once the issue has
been solved, reviewers are asked to close them and to give the authorization to make the
cookbook publicly available.
Public readers can provide comments or feedbacks to improve or extend the cookbook.
3/7
yPBL methodology cookbook
http://homepages.laas.fr/eexposit/ypbl
[cookbook's name] yPBL cookbook
by [author]
last update: __/__/__
Releases
Releases
Date
Author(s)
Description
0.1
Abstract and recipes proposal to reviewers
0.2
Introduction and definitions
0.3
Recipe 1: ….
Update of definitions: …..
0.4
Recipe 2: ….
Update of definitions: …
Update of abstract: …..
…...
1.0
Public release of V 1.0
Status*
* Status: Started, ToReview, Reviewed, Revised, Published
This section is intended to plan and managing the cookbook life-cycle, proposing a set of
releases and the status of each release when started (authors:Started), ready for review
(authors:ToReview), reviewed when the reviewers have read and provided feedback
(reviewers:Reviewed), revised after taking into account the reviews (authors:Revised)
and published when it has been authorized to made the cookbook public for anonymous
users (reviewers:Published).
4/7
yPBL methodology cookbook
http://homepages.laas.fr/eexposit/ypbl
[cookbook's name] yPBL cookbook
by [author]
last update: __/__/__
Introduction
Description of the context of use of the cookbook, the required ingredients and the goals of
the various recipes.
The ingredients: Definitions and terminology
Introduce here all the definitions and the terms required to understand the recipes that will
be elaborated. Include references from external sources used to provide the definitions and
include these references at the end of the cookbook. Try to be precise and short in the
definitions. After writing each recipe, check again this section, to be sure that all the
ingredients have been included.
Ingredient 1
Write here the definition of the ingredient
5/7
yPBL methodology cookbook
http://homepages.laas.fr/eexposit/ypbl
[cookbook's name] yPBL cookbook
by [author]
last update: __/__/__
Recipes
Recipe1: A first recipe (e.g. a HelloWorld recipe)
Introduce here the recipe and indicate the objectives and the required environment to
reproduce the recipe (hardware, software, versions, etc.)
Step1: short description of step 1
Include detailed description step by step and if required insert screen captures, code or any
link required to elaborate the steps (e.g. video captures, links to download specific software,
etc).
Users following your recipe should be able to obtain the same result.
6/7
yPBL methodology cookbook
http://homepages.laas.fr/eexposit/ypbl
[cookbook's name] yPBL cookbook
by [author]
last update: __/__/__
Recommended documentation
Detailed document sources, eg:
Reference 1
URL or bibliographic reference
Feedback
Indicate here the way you would like to keep in touch with the readers (e.g. your email or
any other communication channel)
7/7
yPBL methodology cookbook
http://homepages.laas.fr/eexposit/ypbl