Aller au contenu principal

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.

Décision et réalisation

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 documentaireSignification
RĂ©daction initiale terminĂ©eLe 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 consolidationUne 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.
DisponibleLa 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ĂšreSignification
État actuelFonctionnement rĂ©ellement en place au moment de la rĂ©daction.
Solution transitoireFonctionnement temporairement conservé pendant la conception, le développement ou la migration vers Horizon.
Fonctionnement cibleComportement attendu lorsque l’architecture prĂ©vue d’Horizon sera mise en place.

Ces repĂšres peuvent ĂȘtre associĂ©s Ă  un statut de dĂ©cision.

Exemple

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.

FormulationPortée
Doit / ne doit pasRÚgle ou contrainte obligatoire. Toute exception nécessite une décision explicite et documentée.
Devrait / ne devrait pasRecommandation générale à respecter, sauf justification particuliÚre.
PeutPossibilité 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.
Statuts de réalisation

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.