Comment documenter du code généré utilisé dans un projet robotique ?

Réponse rapide

Du code généré est documenté par son origine, version, spécification, dépendances, revue, tests, limites connues, responsable et conditions de déploiement, afin d’en assurer la traçabilité et la maintenance.

Identifier la production

Outil, modèle ou générateur, paramètres, date et contexte d’entrée sont associés au commit. La propriété et les licences sont vérifiées.

Relier aux vérifications

Revue, analyse statique, tests, couverture, matériel et résultats sont archivés avec le fichier. Les écarts à la spécification sont explicités.

Préparer la suite

Limites, hypothèses, points sensibles et procédure de régénération ou de correction sont écrits. Le projet peut revenir à une version stable sans dépendre d’un contexte perdu.

Sources et références

  1. [1] Robotics and Autonomous Systems — NIST

Cette réponse vous a-t-elle été utile ?