Lire les explications et les éléments probants

Les explications de l’implémentation permettent de partir d’une intention pour comprendre le code et trouver des éléments qui étayent cette description. Concentrez-vous sur le comportement, les pièces justificatives et les questions qui nécessitent encore votre jugement.

Ouvrir les explications de paragraphe et locales

Cliquez sur le texte pour le modifier. Cliquez dans un espace vide du paragraphe, hors de son texte, pour ouvrir son explication de niveau paragraphe, marquée L1.

Certaines explications concernent un mot ou une expression. Survolez le paragraphe pour révéler de courts soulignements, puis cliquez sur l’un d’eux pour lire son explication locale, marquée L2.

Les listes, tableaux et blocs de code peuvent aussi avoir des explications. Une liste entière est analysée ensemble ; les titres ne sont pas analysés isolément.

Vous pouvez laisser ouvertes les notes de plusieurs paragraphes. Chaque paragraphe affiche une seule explication, de paragraphe ou locale, à la fois. Dans une fenêtre étroite, la note peut apparaître sous le paragraphe.

Lire les trois sections

Section	Question traitée	Points à examiner
Réalisation	Comment l’implémentation répond-elle à cette intention ?	Comportement, étapes, cas limites et choix d’implémentation.
Éléments probants	Qu’est-ce qui étaye l’explication ?	Références au code, tests, sorties de commandes et autres éléments consultables.
Points d’attention	Qu’est-ce qui nécessite un jugement supplémentaire ?	Lacunes, choix d’implémentation, risques et suggestions.

Réalisation est développée par défaut. Développez Éléments probants au besoin. Points d’attention est masquée lorsqu’aucun point n’est à signaler.

Pour une récompense après 7 pointages consécutifs, l’explication pourrait décrire le cumul des dates, citer la fonction et les tests concernés et signaler la gestion des voyages entre fuseaux horaires. Le contenu réel dépend de l’analyse de votre projet.

Examiner les éléments probants

Les références au code ouvrent les fichiers dans l’application par défaut du système. Les images peuvent être affichées et agrandies dans la note en marge. Les libellés de pièces telles que les sorties de commandes et les différences de code ouvrent un nouvel onglet. Noea vous avertit si une pièce n’est plus disponible.

Demandez-vous si chaque référence répond à votre question, quelles conditions un test couvre et si ses résultats étayent la conclusion. S’il manque un scénario essentiel, interrogez le paragraphe et demandez une analyse ou une vérification supplémentaire.

Distinguez notamment trois types d’éléments :

Pièce	Ce qu’elle aide à établir	Ce qu’elle n’établit pas
Code d’implémentation ou de test	La logique employée et les scénarios définis par les tests.	Des tests existants n’ont pas nécessairement été exécutés ou réussis.
Résultats d’exécutions antérieures	Ce qui a été exécuté et son résultat à ce moment-là.	Des modifications ultérieures du code peuvent rendre ces résultats inapplicables.
Vérification réellement exécutée maintenant	Le résultat pour l’environnement et le périmètre de cette exécution.	La réussite des scénarios couverts ne prouve rien pour ceux qui ne sont pas testés.

Expliquer et Analyse lisent normalement le code et les éléments existants plutôt que de relancer à chaque fois tests, compilations ou application. Elles vérifient un fait au besoin lorsque la lecture seule ne permet pas d’établir un point essentiel au jugement. Évaluez le périmètre à partir de ce qui a réellement été exécuté.

Pour relancer un test précis, demandez à l’Agent dans une conversation de l’exécuter et d’en rapporter le périmètre et le résultat, puis analysez à nouveau le paragraphe concerné.

Décider quels choix inscrire dans l’intention

« L’implémentation utilise actuellement un stockage local » décrit l’approche actuelle ; cela n’oblige pas les versions futures à la conserver. Les exigences à maintenir appartiennent au document d’intention.

Évaluez l’effet d’un choix sur l’expérience utilisateur, les coûts, la confidentialité, les risques ou les décisions futures. Une fois le choix compris, deux suites sont fréquentes :

L’approche actuelle convient et vous voulez pouvoir la changer plus tard : conservez-la sans en faire une contrainte.
L’approche doit rester vraie dans les versions futures : écrivez explicitement l’exigence et examinez les limites qu’elle introduit.

Vous pourriez accepter aujourd’hui un stockage local des pointages. Si l’usage hors ligne devient essentiel, écrivez « Les utilisateurs peuvent encore pointer sans connexion réseau », puis analysez comment l’implémentation le permet. Exprimer le comportement exigé est généralement plus facile à maintenir que copier une description détaillée de l’implémentation.

Comprendre les points d’attention

Les points d’attention sont classés en lacunes, choix d’implémentation, risques ou suggestions. Ils distinguent les comportements manquants des choix de conception actuels et des sujets à approfondir.

Le marqueur à droite du paragraphe ouvre l’explication concernée. Son nombre compte les panneaux d’explication contenant des points d’attention, pas les problèmes individuels. Une lacune lui donne une couleur plus visible.

Comprenez l’impact avant de décider de corriger le code, d’ajouter des vérifications, de modifier l’intention ou de conserver le comportement actuel. Chaque point ne doit pas nécessairement devenir une exigence. L’absence de marqueur signifie seulement que l’explication actuelle ne liste aucun point d’attention.

Explorer les illustrations de comportement

Certaines explications comprennent une petite illustration interactive du comportement. Vous pouvez l’essayer, la réinitialiser ou examiner sa source.

Ces illustrations s’exécutent dans un environnement isolé sans accès à l’application ni au réseau et ne conservent pas l’état des interactions. Elles expliquent une règle ; vérifier que le vrai logiciel la respecte exige toujours le code et les résultats de vérification.

Vérifier si une explication reste applicable

Texte précédent signifie que l’explication couvre l’intention avant votre modification. Peut-être obsolète signifie que des fichiers lus ou cités ont changé après l’analyse. Dans les deux cas, une nouvelle analyse est justifiée.

Les notes en marge sont en lecture seule. Modifiez l’intention pour changer une exigence ; utilisez Analyse ou Analyser à nouveau pour vérifier une explication. Consultez Garder les explications à jour.