Amministrazione > Creazione di documentazione interna > Concetti > Panoramica della documentazione interna

Panoramica della documentazione interna

La funzione Documentazione interna consente all'utente di aggiungere documentazione personalizzata (in formato testo o come URL) alla guida in linea esistente.

Gli utenti accedono a questa documentazione facendo clic sul pulsante Guida nell'area del prodotto pertinente. Nella Guida del prodotto appare un collegamento a una pagina che visualizza la propria documentazione sotto l'intestazione Documentazione interna.

L'utente crea la documentazione interna nel modulo Amministratore, riquadro Documentazione interna. Per informazioni, vedere Riquadro Documentazione interna.

Esempio:

John è un amministratore di Release Control nell'organizzazione ABC. Sue, l'amministratore Web, comunica a John che eseguirà una manutenzione del sito Web ogni lunedì e chiede a John di creare una categoria di periodo di tempo in Release Control che impedisca a tutti gli utenti di apportare modifiche al sito Web della società tutti i lunedì.

John crea una categoria di periodo di tempo denominata Web_blackout. Quando gli utenti di Release Control accedono al modulo Analisi, Valutazione > scheda Conflitti periodo di tempo, possono scoprire che il change pianificato è in conflitto con questo periodo di tempo Web_blackout. John necessita di un metodo per spiegare agli utenti il motivo per cui esiste questa categoria di periodo di tempo e decide di scrivere una documentazione interna.

Accede al riquadro Documentazione interna, (Modulo > Amministratore > scheda Configurazione > Documentazione interna), seleziona Conflitti periodo di tempo dal riquadro Area prodotto e invia la documentazione compilando i campi richiesti e salvando le modifiche:

Quando gli utenti accedono al modulo Analisi, Valutazione > scheda Conflitti periodo di tempo e fanno clic sul pulsante Guida , nella Guida del prodotto viene visualizzato un collegamento alla documentazione di John che spiega il nuovo periodo di tempo.

Quando gli utenti fanno clic sul collegamento, viene aperto in una pagina separata che visualizza il contenuto inviato da John. John avrebbe potuto decidere anche di documentare il periodo di tempo sul sito Web interno della società, inserendo un URL al posto di inviare il testo nel riquadro Documentazione interna. In questo caso, il collegamento avrebbe aperto direttamente l'URL.