Quelle documentation un déploiement doit-il laisser ?
De quoi permettre à un inconnu de l'entretenir dans deux ans sans vous. Quatre documents : le registre, la spécification, le processus et les décisions. Le registre est celui qui compte le plus, et les décisions sont celui que l'on n'écrit jamais.
Le registre
Quel tag se trouve où, ce qu'il contient, quand il a été posé, et quand il a été remplacé.
C'est le livrable. Les tags sont des consommables et le registre est l'actif, et il doit être exportable dans une forme lisible sans le logiciel qui l'a produit.
Sans lui, remplacer un tag revient à deviner, retirer un emplacement revient à deviner, et un audit est impossible.
Le garder quelque part qui survive au projet, ce qui signifie en général pas dans un tableur sur la machine d'une seule personne.
La spécification
La référence de la puce et le type de tag au sens du NFC Forum. Le support et l'adhésif. Le fournisseur et le lot.
De quoi permettre à quelqu'un de recommander la même chose, et de quoi reconnaître qu'une livraison n'est pas la même chose.
Y inclure le mode de pose et la surface, puisqu'un remplaçant posé différemment lâchera différemment.
Et y inclure la raison de tout ce qui sort de l'ordinaire, par exemple pourquoi un tag pour métal a été choisi pour une surface qui ressemble à du bois.
Le processus
Comment un tag est écrit, vérifié, posé et consigné, dans l'ordre, sous forme d'étapes que quelqu'un peut suivre.
En quoi consiste la vérification et à quoi ressemble un contrôle réussi.
Que faire d'un tag qui échoue à chaque étape.
C'est ce qui permet au déploiement de grandir sans vous, et son absence est la raison pour laquelle les déploiements cessent de grandir au départ de leur auteur.
Les décisions et leurs raisons
Le seul document que personne n'écrit et celui qui fait gagner le plus de temps par la suite.
Pourquoi le tag porte un lien plutôt qu'un contenu. Pourquoi l'adresse est sur ce domaine. Pourquoi il existe un recours imprimé. Pourquoi les tags ne sont pas verrouillés.
Chacune de ces décisions sera renversée par un successeur qui n'en connaît pas la raison, et chaque renversement coûte cher.
Une page d'entrées courtes suffit. C'est l'assurance la moins chère du projet et elle s'écrit en dernier, dans l'urgence, ou pas du tout.
Questions fréquentes
Quel est le document le plus important ?
Le registre de quel tag se trouve où et de ce qu'il contient. Les tags sont des consommables et le registre est l'actif.
Pourquoi documenter les décisions ?
Parce qu'un successeur qui n'en connaît pas la raison les renversera, et que chaque renversement coûte plus cher que n'aurait coûté la raison écrite.
Où le registre doit-il résider ?
Quelque part qui survive au projet et qui s'exporte dans un format lisible. Pas dans un tableur sur la machine d'une seule personne.
Combien de temps cela doit-il prendre ?
Quelques pages. La valeur tient à l'existence du document plutôt qu'à son exhaustivité.