Comment documenter un service ou une action robotique ?

Réponse rapide

Documenter un service ou une action robotique exige de préciser interface, unités, préconditions, effets, états, erreurs, délais, droits, annulation, versions et exemples d’usage.

Un état implicite rend la reprise dangereuse

Documentez préconditions, modes, timeout et comportement de déconnexion afin que chaque client sache ce qui reste actif.

Décrire les données

Nom, type, repère, validité, fréquence ou feedback rendent l’échange interprétable par un autre composant.

Décrire le cycle

Départ, progression, succès, échec, timeout, annulation et reprise sont représentés sans état implicite.

Décrire la sécurité

Autorisation, limites, comportement de déconnexion, arrêt et résultat réellement vérifiable sont inclus dans le contrat.

Sources et références

  1. [1] Robotics and Autonomous Systems — NIST

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