Que documentação uma instalação deve deixar para trás?
O bastante para um estranho mantê-la daqui a dois anos sem você. Quatro documentos: o registro, a especificação, o processo e as decisões. O registro é o que mais importa, e as decisões são o que nunca é escrito.
O registro
Qual tag está onde, o que ela guarda, quando foi fixada e quando foi substituída.
É isso que se entrega de fato. As tags são consumíveis e o registro é o ativo, e ele tem de ser exportável num formato legível sem o software que o produziu.
Sem ele, substituir uma tag quer dizer adivinhar, aposentar um local quer dizer adivinhar, e uma auditoria é impossível.
Guarde-o num lugar que sobreviva ao projeto, o que em geral quer dizer não numa planilha no computador de uma pessoa.
A especificação
A referência do chip e o tipo de tag do NFC Forum. O substrato e o adesivo. O fornecedor e o lote.
O bastante para alguém encomendar a mesma coisa de novo, e o bastante para reconhecer quando uma entrega não é a mesma coisa.
Inclua o método de fixação e a superfície, já que uma substituta fixada de outro jeito vai falhar de outro jeito.
E inclua a razão de qualquer coisa incomum, como por que uma tag para metal foi escolhida para uma superfície que parece madeira.
O processo
Como uma tag é gravada, verificada, instalada e registrada, em ordem, como etapas que alguém consegue seguir.
Em que consiste a verificação e como é uma tag aprovada.
O que fazer com uma tag que falha em cada etapa.
É isso que permite à instalação crescer sem você, e a falta dele é a razão pela qual as instalações param de crescer quando o autor delas vai embora.
As decisões e o porquê
O único documento que ninguém escreve e o que mais economiza tempo depois.
Por que a tag guarda um link e não um conteúdo. Por que o endereço está neste domínio. Por que existe uma reserva impressa. Por que as tags não estão bloqueadas.
Cada uma dessas é uma decisão que quem vier depois vai reverter se não souber a razão, e cada reversão sai cara.
Uma página de entradas curtas basta. É a garantia mais barata do projeto, e ela é escrita por último, com pressa, ou não é escrita.
Perguntas frequentes
Qual é o documento mais importante?
O registro de qual tag está onde e do que ela guarda. As tags são consumíveis e o registro é o ativo.
Por que documentar as decisões?
Porque quem vier depois sem saber por quê vai revertê-las, e cada reversão custa mais do que escrever a razão custou.
Onde o registro deve ficar?
Num lugar que sobreviva ao projeto e exporte para um formato legível. Não numa planilha no computador de uma pessoa.
Que extensão isso deve ter?
Algumas páginas. O valor está em existir, e não em ser exaustivo.