Difference between revisions of "Linee Guida"

Latest revision as of 09:44, 13 October 2017

Note generali per l'inserimento dei dati da parte del personale Tecno Logica[edit]

Informazioni per l'inserimento dei dati[edit]

• Editando le pagine, nella barra in alto compaiono i comandi più frequentemente utilizzati
• Per sapere come formattare i dati che si inseriscono, consultare questa pagina
• Per sapere come effettuare i link, a pagine immagini ecc, consultare questa pagina

Convenzioni[edit]

• Nelle istruzioni che seguono, per per elenco, o carattere bold, si intende link ad altre sottopagine;
• Per lista, si intende insieme delle informazioni nella stessa pagina suddivise per capitoli (come nel presente caso)
• Ogni link creato ad altre pagine, cioè il nome delle pagine, inizia con ogni parola con carattere maiuscolo
• Il nome che identifica invece un paragrafo nella stessa pagina, cioè il nome della sezione, il carattere maiuscolo riguarda solo l'inizio della prima parola.
• Normalmente, gli utilizzatori di TLWiki dovrebbero aggiungere altri capitoli in pagine esistenti, e non altri link se non a pagine già esistenti. Questo per mantenere la struttura.

Metodo seguito per la realizzazione della struttura[edit]

L'impostazione generale consiste nell'individuare prima a grandi linee e poi in maniera sempre più dettagliata gli applicativi principali e quelli accessori. In questo modo, sia in base alle personali conoscenze, che al tipo/livello di informazione necessaria, gli utilizzatori del presente programma possono accedere direttamente e facilmente a tutte le informazioni richieste.

Da una panoramica generale si arriva quindi all'informazione specifica dettagliata. Queste informazioni dettagliate, che possono essere scritte in un'intera pagina, oppure fare parte di una sezione di una pagina come descritto in seguito, possono essere richiamate in qualunque altra parte del programma. In questo modo si può descrivere qualunque cosa tralasciando i dati specifici, ma inserendo i suddetti link nel testo, il lettore può in caso di necessità accedervi e visionarli.

Al momento TLWiki è realizzato per fornire le informazioni utili agli utenti ed al supporto tecnico di 1° e 2° livello. Di seguito le istruzioni per l'inserimento dei dati da parte del personale Tecno Logica, indirizzato sia ai colleghi stessi che agli utilizzatori di TLWiki:

• Suddivisioni

Sidebar[edit]

Sidebar: diviso con utenti, primo livello e secondo livello di supporto

Sezione Utenti[edit]

Sezione dedicata al supporto agli utilizzatori del programma.

Prima pagina: lista applicativi[edit]

Panoramica di tutti gli applicativi principali ed accessori utilizzati dal cliente senza ulteriori informazioni (tutti link) è un primo raggruppamento a grandissime linee. Contiene:

• Eventuali informazioni comuni a tutti gli applicativi
• Informazioni generiche sull’utilizzo di tutti i programmi

Seconda pagina: eventuali schemi a blocchi applicativi selezionati ed informazioni specifiche[edit]

L'intenzione è che da questo livello si possa accedere ad informazioni sempre più dettagliate, attraverso lo schema a blocchi, oppure direttamente ad una specifica funzione (tasto specifico o operazione specifica). Per fare questo si immettono quindi informazioni generiche (approfondite nei link successivi) ed informazioni specifiche, e cioè: Informazioni generiche da approfondire:

• Informazioni comuni a tutte le funzioni dell’intero programma
• Schema a blocchi di ogni applicativo (elenco blocchi)
• Elenco di tutte le funzioni dell’applicativo
• Eventuali operazioni comuni a tutti i blocchi dell’applicativo specifico

Ed informazioni specifiche:

• Link alla singola funzione (tasto) del programma, che sarà un elenco nella stessa pagina.In questo modo il mini-blocco di informazione può essere richiamata/inclusa da qualsiasi altra parte.
• FAQ
• Come fare per..

Terza pagina: elenco funzioni che fanno parte dello stesso blocco selezionato[edit]

Contiene l'elenco delle funzioni riguardano lo stesso blocco selezionato dalla pagina precedente

Quarta pagina: insieme delle informazioni che riguardano la stessa funzione[edit]

Ultimo livello, contiene nella stessa pagina l’insieme, cioè LISTA, delle informazioni che riguardano la stessa funzione. Queste informazioni contenute nella stessa pagina, sono divise in paragrafi (come ad esempio questa). Essendo informazioni dettagliate, queste possono essere riprese come precedentemente spiegato da qualsiasi altra parte del programma come approfondimenti.

Sezione Supporto Tecnico Primo Livello[edit]

Come primo livello è necessario dare informazioni dettagliate su ogni componente dei programmi. Sono descrizioni tecniche necessarie per far capire come il programma è strutturato. Questo dà la possibilità, conoscendo la struttura del programma, di individuare i problemi da risolvere se uno o più componenti del programma non funziona correttamente (inteso che il programma è corretto, ma in quella circostanza per qualche motivo non svolge la sua funzione) Lo schema riprende in questo caso la struttura del supporto utenti.

Prima pagina: elenco di tutti gli applicativi principali ed accessori[edit]

Panoramica degli applicativi sviluppati da Tecno Logica, è un primo raggruppamento a grandissime linee. Deve includere anche i software utilizzati dai programmi, che possono essere anche applicazioni che l'utente non vede. Contiene:

• Eventuali informazioni tecniche comuni a tutti gli applicativi
• Elenco di tutti gli applicativi, principali ed eventuali accessori,
• elenco applicativi accessori

Seconda pagina: informazioni tecniche che riguardano l’intero programma selezionato[edit]

Contiene le informazioni tecniche che riguardano l’intero programma, ed i link per le informazioni tecniche di ciascun blocco del programma. (riprendendo struttura clienti).

• Informazioni di supporto generali (procedure, tipologie..)
• Eventuali informazioni tecniche comuni a tutti i blocchi dell’applicativo
• Schema a blocchi di ogni applicativo (elenco blocchi)
• Elenco funzioni (exe) integrate nel programma

Terza pagina:elenco funzioni che fanno parte dello stesso blocco[edit]

Da questa pagina si iniziano ad inserire i casi risolti. A questo livello si inseriscono i casi risolti che riguardano l'intero blocco del programma, come lista nella stessa pagina. Contiene:

• Eventuali informazioni tecniche che riguardano l'intero blocco dell’applicativo
• Elenco funzioni che fanno parte dello stesso blocco
• Lista eventuali problemi comuni risolti che riguardano tutte le funzioni dello stesso blocco

Quarta pagina: l’insieme delle informazioni tecniche che riguardano la stessa funzione[edit]

Ultimo livello, contiene nella stessa pagina l’insieme delle informazioni tecniche che riguardano la stessa funzione, come divisione in paragrafi. Questo è il livello della LISTA problemi risolti, tutti nella stessa pagina Se eventuali link ad altre sottopagine, le risoluzioni dei problemi si fermano qui’, per evitare di frammentare troppo le informazioni e rendere difficoltosa la reperibilità. Se per uno stesso caso esistono due o più soluzioni diverse, sono inseriti come sottoparagrafi dello stesso problema. Vedere help formattazione per maggiori informazioni.

Sezione Supporto Tecnico Secondo Livello[edit]

La struttura è identica al primo livello, ma si danno per scontate le informazioni tecniche sul funzionamento dei programmi. Nell'ultima sezione quindi si inseriscono i dati tecnici che riguardano le strutture interne ai programmi, come ad esempio nel caso di TLposWin i tracciati record. In linea generale, nel supporto tecnico di secondo livello si inseriscono tutte le informazioni che interfacciano i programmatori, oppure attività che sono al di fuori del normale supporto, come ad esempio la verifica delle offerte Codè. Le prime pagine riprendono quindi gli schemi precedenti, con la variazione nelle ultime pagine di ciascun link che tratteranno informazioni tecniche interne ai programmi stessi. Questo dà la possibilità, di risolvere problemi non dovuti ad eventuali malfunzionamenti durante il normale utilizzo come nel caso del primo livello, ma di dare una base di informazioni utili agli sviluppatori per ampliare/modificare le caratteristiche dei programmi, in caso di errori interni al programma oppure a seguito di specifiche richieste da parte dei clienti. Lo schema riprende anche in questo caso la struttura del supporto utenti e 1° livello.

Prima pagina: elenco applicativi principali ed accessori[edit]

Panoramica degli applicativi sviluppati da Tecno Logica, è un primo raggruppamento a grandissime linee. Deve includere anche i software accessori e quelli utilizzati dai programmi.

Seconda pagina: informazioni tecniche che riguardano l’intero programma selezionato[edit]

Contiene le informazioni tecniche che riguardano l’intero programma, ed i link per le informazioni tecniche di ciascun blocco del programma. (riprendendo struttura clienti e primo livello).

• Informazioni di supporto specifiche per l'applicativo selezionato (es file di configurazione di sistema ecc..)
• Schema a blocchi di ogni applicativo (elenco blocchi)
• Eventuali informazioni tecniche comuni a tutti i blocchi dell’applicativo
• Elenco funzioni (exe) integrate nel programma

Terza pagina: elenco funzioni che fanno parte dello stesso blocco[edit]

• Link alle funzioni che fanno parte dello stesso blocco
• Lista eventuali informazioni tecniche che riguardano tutte le funzioni dello stesso blocco
• Lista problemi risolti che riguardano l'intero blocco

Quarta pagina: insieme delle informazioni tecniche che riguardano la stessa funzione[edit]

ultimo livello, contiene nella stessa pagina l’insieme delle informazioni tecniche che riguardano la stessa funzione, come divisione in paragrafi. Questo è il livello della LISTA problemi risolti della specifica funzione, tutti nella stessa pagina. Nel caso delle casse ad esempio, in questa sezione si inseriscono i tracciati record di tutte le casse utilizzate. In generale, tutte le informazioni tecniche della funzione in ottica di utilizzo da parte dei programmatori. Se eventuali link ad altre sottopagine, le risoluzioni dei problemi si fermano qui’, per evitare di frammentare troppo le informazioni e rendere difficoltosa la loro reperibilità.