View source for Clément:TemplateProjet

'''A propos'''

* Cette page sert de template pour la création de nouveaux projets.
* Tout le contenu de cette page est sous license (TODO: choix license => CC-SA Electrolab ?)
* Merci de vous reporter aux pages spécifiques (TODO: link) à propos de l'utilisation de ce wiki.

'''Remarques:'''
* Toute remarque, critique constructive ou suggestion à propos de ce template est bienvenue (sur la ML de l'electrolab, idéalement)
* Pour se servir correctement de ce template, remplacez chacun des points TODO par du texte véritable dès que possible - quitte à supprimer des points existants dans le template, mais non encore pertinents sur votre page. Il sera toujours temps de récupérer à nouveau ces même points directement sur le template.
* Pour limiter la taille de la page principale, il est envisageable (voire souhaitable) :
** de placer chacune des grandes sections (Principes, Ressources, Réalisation, Résultats) dans des pages filles.
** de placer chacun des points sur une page fille spécifique, en ne conservant sur la page projet que le résumé (statut, descriptif, etc) de celui-ci.
* Il pourrait être envisageable de versionner la page principes (eg v(major).(minor) ). Les pages ressources/réalisation/résultat n'ont pas à être versionnées.
* pour permettre la pleine efficacité de ce template, il serait nécessaire d'étendre les capacités/features du wiki utilisé (gestion dynamique du contenu, intégration à un système de versionning(pour les fichiers de design), à un système de gestion de planning/tâches, etc). La possibilité de grepper directement les champs TODO par exemple serait excellente. Ou encore de remonter certaines infos/statuts d'une page fille vers la page mère. Par exemple, il est malaisé de garantir l'unicité (et donc la cohérence, l'actualisation) des informations réparties sur différentes pages...


----

= Trucs en cours/à trier/fourre tout =
  ''Permet de caser des choses à la va-vite sans polluer le reste. Idéalement daté/signé, puis transféré dans les catégories adéquates au fil du temps.''

= Introduction =
  ''Cette section vise à donner un aperçu du projet''
(TODO: texte introductif)
== Contexte & Objectifs ==
Ce projet a pour but de (TODO: texte description), avec plusieurs objectifs:
* (TODO: texte objectif principal 1)
* (TODO: texte objectif principal 2)
* (TODO: texte objectif principal 3)

(TODO: texte objectifs annexes, par ex temporel, organisation, ...)

== Fonctionnalités ==
On envisage dans un premier temps les modes de fonctionnement suivants:
* (TODO: texte feature 1.1)
* (TODO: texte feature 1.2)
* (TODO: texte feature 1.3)
* (TODO: texte feature 1.4)

Il est à préciser que (TODO: texte feature 2):
* (TODO: texte feature 2.1)
* (TODO: texte feature 2.2)
* (TODO: texte feature 2.3)
* (TODO: texte feature 2.4)


= Ressources =
  ''cette section rassemble les informations pratiques pour la bonne marche du projet
  Potentiellement, elle devrait être intégrée/fusionnée à la page/section principes''

== Etat de l'art ==
(TODO: texte etat de l'art)

== Liens ==
* (TODO: liens ressource 1)
* (TODO: liens ressource 2)
* (TODO: liens ressource 3)
* (TODO: liens ressource 4)

== matériel & ressources nécessaires ==
* (TODO: matériel/ressource 1)
* (TODO: matériel/ressource 2)
* (TODO: matériel/ressource 3)
* (TODO: matériel/ressource 4)

= Principes =
  ''Détaille les grandes lignes du projet. A noter qu'il est possible de détailler des aspects autres que ceux évoqués (par exemple fabrication, distribution, documentation, ...).
  Il serait également souhaitable de versionner cette page, c'est à dire effectuer un freeze pour chaque major rev. (peut etre aussi pour chaque minor rev.)''

== Mécanique ==
* (TODO: texte principe meca 1)
* (TODO: texte principe meca 2)
* (TODO: texte principe meca 3)
* (TODO: texte principe meca 4)

== Electronique ==
* (TODO: texte principe elec 1)
* (TODO: texte principe elec 2)
* (TODO: texte principe elec 3)
* (TODO: texte principe elec 4)

== Logiciel ==
* (TODO: texte principe logiciel 1)
* (TODO: texte principe logiciel 2)
* (TODO: texte principe logiciel 3)
* (TODO: texte principe logiciel 4)


== Exigences ==
  ''les exigences sont à comprendre au sens de ''requirement'' (gestion de projet), et doivent décrire des aspects chiffrés du projet, permettant d'en faire une évaluation a priori ou a posteriori de facon précise.''
* (TODO: texte exigence 1)
* (TODO: texte exigence 2)
* (TODO: texte exigence 3)
* (TODO: texte exigence 4)

== Macro planning ==
  ''le macro planning permet de décrire les différentes étapes du projet (les jalons), positionnés approximativement dans le temps (futur lors de l'écriture).''
* (TODO: texte jalon 1)
* (TODO: texte jalon 2)
* (TODO: texte jalon 3)
* (TODO: texte jalon 4)

== Organisation ==
(TODO: texte organisation projet)

=== Personnes impliquées/partenaires ===
* (TODO: acteur/role 1)
* (TODO: acteur/role 2)
* (TODO: acteur/role 3)
* (TODO: acteur/role 4)

=== meetings/sessions de travail/modes opératoires ===
(TODO: texte organisation travail)

=== Aspects financiers ===
(TODO: texte organisation financement)

= Réalisation/en cours =
  ''Donne une vue actuelle du travail en cours sur le projet. Cette section est celle qui est amenée à bouger tout le temps, au fur et à mesure de l'avancement du projet:
  * cette section est '''le coeur''' du projet ;
  * chacune des questions ouvertes permet de peaufiner/adapter les jalons ;
  * chacun des points détaille les aspects des jalons identifiés dans le macroplanning, et sert d'ébauche pour la partie résultats.''

== Historique ==
  ''Retrace le déroulement du projet: c'est le pendant du macroplanning, et est écrit au passé (voire présent). Permet de se faire une idée concise de l'état actuel du projet''
* (TODO: historique1: date description)
* (TODO: historique2: date description)
* (TODO: historique3: date description)
* (TODO: historique4: date description)

== Questions ouvertes/problèmes ==
  ''Rassemble les points soulevés/à soulever, et éventuellement des ébauches de discussions & éléments pertinents pour avancer.
  * A chaque question doit être associé un statut (tranché/en cours, etc).
  * Les différentes contributions sont idéalement datées et signées par leur auteur.
  * Toute question non triviale doit faire en principe l'objet d'un point abordé dans la section réalisation.''

=== TODO: question ouverte 1 ===
(TODO: texte question ouverte 1 statement du problème)

* (TODO: texte contribution à question ouverte 1.1)
* (TODO: texte contribution à question ouverte 1.2)
* (TODO: texte contribution à question ouverte 1.3)
* (TODO: texte contribution à question ouverte 1.4)

(TODO: texte question ouverte 1 statut/conclusion)

=== TODO: question ouverte 2 ===
(TODO: texte question ouverte 2 statement du problème)

* (TODO: texte contribution à question ouverte 2.1)
* (TODO: texte contribution à question ouverte 2.2)
* (TODO: texte contribution à question ouverte 2.3)
* (TODO: texte contribution à question ouverte 2.4)

(TODO: texte question ouverte 2 statut/conclusion)

== Point 0 : (TODO: texte description point 0) ==
* '''STATUT''': (TODO: texte statut point 0)
* '''ACTEUR(S)''': (TODO: texte acteur(s) point 0)
* '''REMARQUES''':

=== TODO 0.0: (TODO: texte description todo 0.0) ===
  ''ici, placer les éléments pertinents liés à ce point, en cours d'élaboration''
=== TODO 0.1: (TODO: texte description todo 0.1) ===
  ''ici, placer les éléments pertinents liés à ce point, en cours d'élaboration''
=== TODO 0.2: (TODO: texte description todo 0.2) ===
  ''ici, placer les éléments pertinents liés à ce point, en cours d'élaboration''

== Point 1 : (TODO: texte description point 1) ==
* '''STATUT''': (TODO: texte statut point 1)
* '''ACTEUR(S)''': (TODO: texte acteur(s) point 1)
* '''REMARQUES''':

=== '''TODO 1.0''': (TODO: texte description todo 1.0) ===
  ''ici, placer les éléments pertinents liés à ce point, en cours d'élaboration''
=== '''TODO 1.1''': (TODO: texte description todo 1.1) ===
  ''ici, placer les éléments pertinents liés à ce point, en cours d'élaboration''
=== '''TODO 1.2''': (TODO: texte description todo 1.2) ===
  ''ici, placer les éléments pertinents liés à ce point, en cours d'élaboration''

= Prototypes, résultats, archive =
  ''Donne une vue détaillée des résultats obtenus (discussion, expérimentation, prototype, documentation, tutorial, ...).
  * Basés sur les ébauches de la section 'en cours' : les points clos peuvent/doivent naturellement migrer dans cette section.
  * potentiellement, cette section n'est que l'aggrégat des éléments de la section réalisation dont le statut est "clos" ou similaire.''

== Résultat 1 ==
(TODO: texte description résultat 1
=== Résumé ===
(TODO: texte résumé résultat 1)
=== Fichiers ===
(TODO: code, photos, ... résultat 1)

=== Remarques/critiques/bilan ===
(TODO: bilan résultat 1)

== Résultat 2 ==
(TODO: texte description résultat 2)
=== Résumé ===
(TODO: texte résumé résultat 2))
=== Fichiers ===
(TODO: code, photos, ... résultat 2)

=== Remarques/critiques/bilan ===
(TODO: bilan résultat 2)