Aggiornare Documentazione
La KB deve essere aggiornata insieme al codice. Ogni modifica funzionale deve produrre almeno una verifica documentale.
Quando aggiornare
Sezione intitolata “Quando aggiornare”- Nuovo endpoint REST.
- Nuovo widget o modifica schema JSON.
- Cambio contratto tra tema e plugin.
- Nuova capability o policy di sicurezza.
- Rilascio di versione.
- Modifica visibile alla UI o ai flussi illustrati da screenshot.
- Modifica a installazione, deploy o rollback.
Procedura
Sezione intitolata “Procedura”- Aggiornare il documento sorgente locale del componente.
- Aggiornare o creare la pagina corrispondente in questa KB.
- Eseguire
npm run build. - Pubblicare la cartella
dist/sukb.smartecommerce.it/httpdocs. - Verificare URL, ricerca e navigazione laterale.
- Se la UI e cambiata, acquisire nuovamente le schermate dall’ultima release installata.
Convenzioni
Sezione intitolata “Convenzioni”- Titoli chiari e stabili.
- Endpoint in blocchi codice.
- Tabelle per versioni, capability e responsabilita.
- Link interni quando una procedura dipende da un altro prodotto.
- Screenshot reali, senza credenziali o dati personali, nominati con prodotto,
pagina e versione:
smart-login-identity-oauth-2.8.2.webp. - Ogni immagine deve avere testo alternativo utile e indicare nella didascalia la versione del prodotto. Mockup e schermate di versioni precedenti non devono essere usati come riferimento operativo.
