Conventions utilisées dans le document
La documentation du Projet Horizon présente simultanément des systÚmes existants, des décisions de conception, des fonctionnalités envisagées et des objectifs à plus long terme. Des conventions communes sont utilisées afin de distinguer clairement ces différents niveaux.
Les statuts prĂ©sentĂ©s dans ce chapitre indiquent principalement le degrĂ© de dĂ©finition ou de validation dâun Ă©lĂ©ment. Ils ne dĂ©crivent pas son Ă©tat de dĂ©veloppement.
Une fonctionnalitĂ© peut ĂȘtre validĂ©e sans avoir encore Ă©tĂ© dĂ©veloppĂ©e. Ă lâinverse, un systĂšme peut appartenir Ă lâĂ©tat actuel tout en constituant seulement une solution temporaire destinĂ©e Ă ĂȘtre remplacĂ©e par Horizon.
Statuts de dĂ©finition et de dĂ©cisionâ
Les quatre premiers statuts dĂ©crivent la progression habituelle dâune dĂ©cision :
Ă dĂ©finir â En rĂ©flexion â Ă valider â ValidĂ©
Les mentions PrĂ©vu, Hors pĂ©rimĂštre et AbandonnĂ© prĂ©cisent plutĂŽt la place dâun Ă©lĂ©ment dans la trajectoire gĂ©nĂ©rale du projet.
Statuts documentairesâ
Les statuts documentaires décrivent la maturité d'une page ou d'un ensemble de chapitres. Ils ne remplacent ni les statuts de décision ni les futurs statuts de réalisation.
| Statut documentaire | Signification |
|---|---|
| RĂ©daction initiale terminĂ©e | Le contenu prĂ©vu est prĂ©sent, mais une revue ou une consolidation peut encore ĂȘtre nĂ©cessaire avant qu'il ne devienne la rĂ©fĂ©rence courante. |
| En consolidation | Une revue a identifiĂ© des corrections ciblĂ©es en cours d'intĂ©gration. Le contenu reste consultable, mais les points concernĂ©s ne doivent pas ĂȘtre considĂ©rĂ©s comme stabilisĂ©s. |
| Disponible | La page constitue la rĂ©fĂ©rence documentaire courante. Elle peut encore Ă©voluer avec le projet sans ĂȘtre considĂ©rĂ©e comme dĂ©finitive. |
| Validé | Une décision explicitement identifiée a été retenue. Ce terme qualifie une décision ou un principe, et non automatiquement l'intégralité de la page qui le contient. |
Une partie peut donc ĂȘtre disponible comme rĂ©fĂ©rence courante tout en contenant des sujets prĂ©vus, indicatifs ou encore Ă dĂ©finir. Inversement, une dĂ©cision validĂ©e peut apparaĂźtre dans un chapitre dont la rĂ©daction globale reste en consolidation.
Ă dĂ©finirâ
Le sujet a Ă©tĂ© identifiĂ©, mais aucune solution suffisamment prĂ©cise nâa encore Ă©tĂ© Ă©tudiĂ©e.
Ce statut permet de signaler quâune dĂ©cision sera nĂ©cessaire sans laisser entendre quâune orientation particuliĂšre a dĂ©jĂ Ă©tĂ© retenue.
En rĂ©flexionâ
Le sujet est en cours dâĂ©tude. Plusieurs possibilitĂ©s peuvent ĂȘtre envisagĂ©es, comparĂ©es ou expĂ©rimentĂ©es, mais aucune proposition nâest encore prĂȘte Ă ĂȘtre soumise Ă une validation dĂ©finitive.
Les éléments présentés sous ce statut peuvent évoluer fortement.
Ă validerâ
Une proposition suffisamment prĂ©cise existe et constitue lâorientation privilĂ©giĂ©e, mais elle attend encore une confirmation formelle avant de devenir la rĂ©fĂ©rence du projet.
Des ajustements restent possibles avant sa validation.
ValidĂ©â
La décision a été retenue et constitue la référence actuelle du Projet Horizon.
Un Ă©lĂ©ment validĂ© doit ĂȘtre pris en compte dans les dĂ©cisions et les dĂ©veloppements futurs tant quâil nâest pas explicitement remplacĂ© par une nouvelle dĂ©cision. Ce statut ne signifie pas que lâĂ©lĂ©ment est dĂ©jĂ dĂ©veloppĂ©, testĂ© ou disponible.
PrĂ©vuâ
LâĂ©lĂ©ment est retenu dans la trajectoire du projet, mais son fonctionnement dĂ©taillĂ©, son contenu exact ou ses conditions de rĂ©alisation peuvent encore rester Ă dĂ©finir.
Une fonctionnalitĂ© prĂ©vue nâest donc ni une simple idĂ©e ni nĂ©cessairement une dĂ©cision entiĂšrement validĂ©e. Certains de ses principes peuvent ĂȘtre Ă©tablis tandis que ses modalitĂ©s restent en rĂ©flexion.
Hors pĂ©rimĂštreâ
LâĂ©lĂ©ment nâest pas pris en charge dans le pĂ©rimĂštre considĂ©rĂ©.
Le pĂ©rimĂštre concernĂ© doit toujours ĂȘtre prĂ©cisĂ© :
- Hors pĂ©rimĂštre dâune phase de conception.
- Hors pĂ©rimĂštre dâun prototype.
- Hors pĂ©rimĂštre dâune version.
- Hors périmÚtre de la V1.
- Hors périmÚtre du Projet Horizon.
Ătre hors pĂ©rimĂštre dâune version ne signifie pas que lâĂ©lĂ©ment est abandonnĂ©. Il peut ĂȘtre reportĂ© Ă une Ă©tape ultĂ©rieure.
AbandonnĂ©â
La proposition a été étudiée, puis explicitement écartée.
Un Ă©lĂ©ment abandonnĂ© ne reste prĂ©sentĂ© dans la documentation courante que sâil permet de comprendre une dĂ©cision importante ou dâĂ©viter que la mĂȘme piste soit rĂ©examinĂ©e sans raison. Dans les autres cas, son ancienne prĂ©sence reste consultable dans Git.
Les abandons ayant une influence majeure sur lâĂ©volution dâHorizon peuvent Ă©galement ĂȘtre mentionnĂ©s dans le chapitre consacrĂ© Ă lâhistorique des versions.
RepĂšres temporelsâ
Horizon doit progressivement reprendre ou remplacer plusieurs systĂšmes dĂ©jĂ employĂ©s dans La TaniĂšre. Les repĂšres suivants permettent de distinguer ce qui existe aujourdâhui du fonctionnement envisagĂ© Ă terme.
| RepĂšre | Signification |
|---|---|
| Ătat actuel | Fonctionnement rĂ©ellement en place au moment de la rĂ©daction. |
| Solution transitoire | Fonctionnement temporairement conservé pendant la conception, le développement ou la migration vers Horizon. |
| Fonctionnement cible | Comportement attendu lorsque lâarchitecture prĂ©vue dâHorizon sera mise en place. |
Ces repĂšres peuvent ĂȘtre associĂ©s Ă un statut de dĂ©cision.
Fonctionnement cible â ValidĂ©
Twitch, Discord et le poste de commande Web utilisent une identitĂ© centrale commune pour chaque membre de lâĂ©quipage.
La mention Fonctionnement cible ne signifie toutefois pas que le fonctionnement décrit est déjà disponible.
Informations indicativesâ
La mention Indicatif signale une information utilisée comme repÚre de planification ou comme hypothÚse de travail, sans constituer un engagement définitif.
Elle peut notamment accompagner :
- Une date ou une période.
- Une estimation de charge.
- Une durée de développement.
- Le contenu prĂ©visionnel dâune version.
- Un volume de donnĂ©es ou dâutilisateurs.
- Un exemple dâarchitecture ou dâimplĂ©mentation.
Sauf indication contraire, les calendriers, les charges de travail et le contenu des futures versions prĂ©sentĂ©s dans cette documentation doivent ĂȘtre considĂ©rĂ©s comme indicatifs. Ils pourront ĂȘtre rĂ©visĂ©s en fonction de lâapprentissage technique, des difficultĂ©s rencontrĂ©es et de lâĂ©volution du pĂ©rimĂštre.
Qualification des valeurs numĂ©riquesâ
Une valeur numĂ©rique prĂ©sentĂ©e dans la documentation doit ĂȘtre accompagnĂ©e d'un statut lorsque sa portĂ©e pourrait ĂȘtre ambiguĂ«. Horizon distingue notamment :
- Une Exigence fonctionnelle, dont la valeur fait partie du comportement validé.
- Une Valeur initiale configurable, retenue pour le premier fonctionnement mais modifiable sans remettre en cause le principe fonctionnel.
- Une HypothĂšse d'expĂ©rimentation, destinĂ©e Ă ĂȘtre confirmĂ©e ou corrigĂ©e par les essais.
- Une Limite de service, imposée par un fournisseur, une interface ou une capacité technique externe.
- Une Information indicative, utilisée comme ordre de grandeur sans constituer une rÚgle.
Une valeur initiale configurable ne doit pas ĂȘtre prĂ©sentĂ©e comme une constante dĂ©finitive. Sa modification doit rester contrĂŽlĂ©e, traçable lorsqu'elle affecte des donnĂ©es ou des droits, et compatible avec les garanties fonctionnelles du chapitre concernĂ©.
Lorsqu'un seuil exact dĂ©pend encore d'essais techniques, le chapitre doit dĂ©finir le principe attendu et signaler explicitement que la valeur reste Ă mesurer. L'absence de valeur dĂ©finitive ne doit pas conduire Ă employer une plage ambiguĂ« dans une rĂšgle destinĂ©e Ă ĂȘtre exĂ©cutĂ©e.
Force des formulationsâ
Certains chapitres, notamment ceux consacrĂ©s Ă lâarchitecture, aux permissions et Ă la sĂ©curitĂ©, utilisent des formulations exprimant diffĂ©rents niveaux de contrainte.
| Formulation | Portée |
|---|---|
| Doit / ne doit pas | RÚgle ou contrainte obligatoire. Toute exception nécessite une décision explicite et documentée. |
| Devrait / ne devrait pas | Recommandation générale à respecter, sauf justification particuliÚre. |
| Peut | Possibilité autorisée ou comportement facultatif. |
Ces termes permettent de distinguer une exigence indispensable au fonctionnement ou Ă la sĂ©curitĂ© dâHorizon dâune simple prĂ©fĂ©rence de conception.
Convention Ă©ditoriale des listesâ
Afin de maintenir une présentation homogÚne dans l'ensemble de la documentation :
- Chaque élément de liste commence par une majuscule.
- Chaque élément de liste se termine par un point.
- Une liste ne doit pas employer une succession de points-virgules pour relier artificiellement des éléments indépendants.
- Une phrase introductive doit rester grammaticalement correcte lorsque les éléments de la liste sont lus séparément.
Cette convention s'applique aux listes Ă puces de la documentation. Les tableaux, fragments de code, chemins, identifiants techniques et composants d'interface suivent les rĂšgles propres Ă leur format.
RĂšgles dâutilisationâ
Les conventions nâont pas vocation Ă accompagner systĂ©matiquement chaque paragraphe. Elles sont affichĂ©es lorsque le niveau de dĂ©finition, la pĂ©riode concernĂ©e ou la portĂ©e dâune information pourrait prĂȘter Ă confusion.
Plusieurs conventions peuvent ĂȘtre combinĂ©es lorsquâelles dĂ©crivent des dimensions diffĂ©rentes. Une fonctionnalitĂ© peut, par exemple, ĂȘtre Ă la fois :
- Prévue pour une future version.
- Fondée sur un principe déjà validé.
- Décrite selon son fonctionnement cible.
- Associée à une date de réalisation indicative.
Lâabsence de statut technique ne permet jamais de conclure quâune fonctionnalitĂ© est dĂ©jĂ dĂ©veloppĂ©e. Les statuts de rĂ©alisation tels que Non commencĂ©, En dĂ©veloppement, ImplĂ©mentĂ©, TestĂ© ou DĂ©ployĂ© seront ajoutĂ©s lorsque le dĂ©veloppement dâHorizon aura dĂ©butĂ©.
Ăvolution des conventionsâ
Cette liste constitue la convention initiale de la documentation. Elle pourra ĂȘtre complĂ©tĂ©e Ă mesure que le Projet Horizon gagnera en maturitĂ©.
Toute nouvelle convention utilisĂ©e rĂ©guliĂšrement devra ĂȘtre dĂ©finie dans ce chapitre afin de conserver une interprĂ©tation commune dans lâensemble de la documentation.