Procedure Generali¶

Documentazione locale cliente¶

E' stata resa disponibile la possibilita' a ciascun cliente di creare dei documenti di aiuto personalizzati, specifici per ciascuna funzione. A questo scopo sono state create 3 nuove configurazioni sotto al gruppo "help":

Parametro	Descrizione
documentazione-cliente	In base a questo parametro, quando un utente preme il pulsante o tasto funzione "Aiuto", il comportamento sara' il seguente: - "N": Apertura diretta documentazione Eurosystem2000 - "S": Apertura diretta documentazione cliente - "R": A richiesta
path-documentazione-cliente	Percorso in modalita' "Client" dove il sistema cerchera' e permettera' di memorizzare la documentazione interna del cliente. Es.: p:\eurocoge\doc-cli
ext-documentazione-cliente	In base all'estensione dichiarata, il sistema usera' il programma appropriato per aprire una documentazione interna del cliente Es. docx

Quindi, se prevista l'attivazione della documentazione cliente, in funzione della posizione nel menu in cui si e' premuto il tasto funzione F1 il sistema potra' cercare ed aprire il documento costruito dal cliente. Se il documento relativo all'argomento non esiste apparira' un messaggio che chiede se si vuole creare il documento.

In questo modo l'utente potra' decidere, se necessario, di creare il documento con le istruzioni per la specifica funzione o per il menu selezionato.

NB: Nella cartella dichiarata, il nome del file dovra' essere di questo tipo: - dt-nome_programma.xxx se il documento viene inserito a livello di programma - ds-codice_menu.xxx se il documento viene inserito a livello di menu

Il nome del programma viene visualizzato ogni volta che si apre l'help del programma/menu.

La documentazione standard dei programmi e dei menu viene scritta in Clickup. Rispetto alla documentazione precedente su H&M, ha lo svantaggio che il link alla pagina non puo' essere calcolato automaticamente, ma dovra' essere associato alla voce di menu (menu o programma) manualmente.

Inserimento/modifica documentazione¶

La documentazione pubblica va inserita nel documento "Manuale Area".

Ogni programma potra' avere la propria pagina, all'interno dell'albero del menu in cui e' posizionato, e potra' essere diviso se necessario in sotto-pagine. Anche le voci di menu possono essere documentate, come si faceva gia' all'interno di H&M.

Attenzione: Non appena inserita, la pagina e' gia' pubblicata e visibile da tutti. Quindi, sarebbe utile scrivere la documentazione in una pagina al di fuori del manuale pubblicato, e copiarlo all'interno quando il documento e' completo. E' necessario quindi prestare attenzione al formato, alla sintassi e al contenuto della pagina del manuale.

Recupero link alla pagina¶

Dopo aver messo la pagina nel manuale pubblico, aprirla all'interno di Clickup, posizionarsi sulla voce nell'albero del menu e cliccare su "...".

Quindi cliccare su "Copia link", e incollare il contenuto in un editor di testo; ad esempio:

https://app.clickup.com/9012645971/docs/8ck442k-22292/8ck442k-47832

La parte di link utile e' quella dopo l'ultimo "/", in questo caso:

8ck442k-47832

Programmi: collegamento¶

In Screens, nella maschera principale e' stato aggiunto un campo in cui sara' visibile e modificabile il link alla pagina di manuale.

Collegare quindi nel campo "Pagina di help" la parte di link utile.

La documentazione di menu dovrebbe essere circoscritta a casi particolari, e per ora non e' prevista una funzione di gestione del collegamento; usare quindi il gestore di tabella YASKHELP.

Le voci di menu sono associate a: - mhelp-tipo-oggetto = "M" - mhelp-oggetto = codice numerico del menu, che si recupera con "Ctrl-F8" sul menu interessato

Procedure: collegamento¶

La sezione del manuale clienti "Procedure" dovrebbe essere quella piu' completa e meglio trattata, anche se per il momento non e' presente un link diretto ad esse.

E' comunque buona norma riportare il link delle procedure interessate nei singoli programmi, copiando il link alla pagina come spiegato sopra, e incollandolo direttamente nella pagina del programma interessato.

Estratto da documentazione interna ClickUp