Regole Aggiornamento Documentazione

Principio

Nessuna feature e completa senza documentazione aggiornata.

Regole

1. ogni modifica funzionale aggiorna almeno una pagina tecnica e una operativa;
2. ogni modifica infrastrutturale aggiorna anche runbook/troubleshooting;
3. ogni rilascio aggiorna docs/changelog.md;
4. evitare doc duplicate: una fonte unica per tema.

Formato pagina consigliato

• Scopo
• Prerequisiti
• Passi operativi
• Errori comuni
• Note di sicurezza

Ownership

• chi implementa aggiorna la docs nello stesso task;
• review tecnica include verifica documentazione.

Enforcement automatico

• Workflow CI: .github/workflows/docs.yml
• Guard script: tools/check_docs_guard.py
• Regola bloccante PR:
• se cambia codice (app/, config.py, requirements.txt, run.py)
• devono cambiare anche:
  • almeno un file in docs/
  • docs/changelog.md