documentazione tecnica di un applicazione web

fofo13

Nuovo Utente
20 Nov 2013
28
0
0
milano
Ragazzi sto realizzando un applicazione per la gestione di materiali.Utilizzando php,postgres e apache devo realizzare la documentazione tecnica + test .Avete una scaletta da seguire?Cosa devo mettere secondo voi?
 

marino51

Utente Attivo
28 Feb 2013
3.041
192
63
Lombardia
Ciao,
in realtà per rispondere alla tua domanda bisogna scrivere un libro ....

La documentazione allegata ad un progetto dipende ovviamente dalla complessità dello stesso,

Un semplice carico e scarico, senza valorizzazione porterà ad una documentazione semplice,

un "magazzino" complesso produrrà una documentazione molto sviluppata nei dettagli
per magazzino complesso intendo la gestione delle decine di tipologie di movimentazione per entrate e uscite,
ma anche conti deposito, conti lavorazione, conti riparazione, prestiti d'uso, avanzamento della produzione se vista come magazzini in successione"

la documentazione deve tener conto dell'udienza a cui si rivolge, inutile spiegare ad un responsabile contabile le operazioni specifiche degli operatori di magazzino, ma utilissimo spiegare la valorizzazione delle giacenze nelle sue sfacettature

quindi in prima battuta, pianifica la tua documentazione, a chi ti rivolgi e cosa devi documentare
basta un indice dei "volumi" da produrre (scusa il termine), indice che rivedrai con la formazione di nuove idee

in seconda, sempre con indici, pianifica il contenuto di ciascun volume e la sua finalità, come dicevo distingui la descrizione al responsabile di funzione rispetto all'operatore di magazzino, rispetto al responsabile IT che vorrà anche lui la sua parte

all'operativo dovrai consegnare "schede" con descritto, attraverso esempi reali, come dovrà gestire il singolo processo
avrai quindi "schede" specifiche per ogni processo che meriti il dettaglio

e ... se lavori ad indici, ti verrà facile modificarli secondo le nuove idee o in funzione di nuove decisioni

mi fermo ...
ciao
marino
 

fofo13

Nuovo Utente
20 Nov 2013
28
0
0
milano
che dire grazie..io sto semplicemente descrivendo le funzionaità in modo non superficiale, di ogni utente. Se vi sono controlli nelle varie schermate di erorri, sto descrivendo semplicemente il loro principio. Es non puoi inserire una mail se non è ben formato cioè string + @ ]+ stringa + . + stringa. Le funzionalità simili le descrivo solo una volta dettagliatamente. Ogni qualvolta se ne presenta una simile es lista utenti facco riferimento a descrizioni precedenti.
Grazie della bella risposta

Ciao,
in realtà per rispondere alla tua domanda bisogna scrivere un libro ....

La documentazione allegata ad un progetto dipende ovviamente dalla complessità dello stesso,

Un semplice carico e scarico, senza valorizzazione porterà ad una documentazione semplice,

un "magazzino" complesso produrrà una documentazione molto sviluppata nei dettagli
per magazzino complesso intendo la gestione delle decine di tipologie di movimentazione per entrate e uscite,
ma anche conti deposito, conti lavorazione, conti riparazione, prestiti d'uso, avanzamento della produzione se vista come magazzini in successione"

la documentazione deve tener conto dell'udienza a cui si rivolge, inutile spiegare ad un responsabile contabile le operazioni specifiche degli operatori di magazzino, ma utilissimo spiegare la valorizzazione delle giacenze nelle sue sfacettature

quindi in prima battuta, pianifica la tua documentazione, a chi ti rivolgi e cosa devi documentare
basta un indice dei "volumi" da produrre (scusa il termine), indice che rivedrai con la formazione di nuove idee

in seconda, sempre con indici, pianifica il contenuto di ciascun volume e la sua finalità, come dicevo distingui la descrizione al responsabile di funzione rispetto all'operatore di magazzino, rispetto al responsabile IT che vorrà anche lui la sua parte

all'operativo dovrai consegnare "schede" con descritto, attraverso esempi reali, come dovrà gestire il singolo processo
avrai quindi "schede" specifiche per ogni processo che meriti il dettaglio

e ... se lavori ad indici, ti verrà facile modificarli secondo le nuove idee o in funzione di nuove decisioni

mi fermo ...
ciao
marino
 

marino51

Utente Attivo
28 Feb 2013
3.041
192
63
Lombardia
Prova a metterti dalla parte dell'operatore,
credo sappia anche lui come inserire un indirizzo email

forse saprà meno come gestire un "conto deposito" con il tuo software,

a mio avviso dovresti concentrarti di più sui processi che non sulle questioni formali
aiuterà in futuro anche cambi nell'organizzazione (nuovi dipendenti) a mantenere il tuo prodotto sempre valido per l'azienda

ciao
 

fofo13

Nuovo Utente
20 Nov 2013
28
0
0
milano
Prova a metterti dalla parte dell'operatore,
credo sappia anche lui come inserire un indirizzo email

forse saprà meno come gestire un "conto deposito" con il tuo software,

a mio avviso dovresti concentrarti di più sui processi che non sulle questioni formali
aiuterà in futuro anche cambi nell'organizzazione (nuovi dipendenti) a mantenere il tuo prodotto sempre valido per l'azienda

ciao
guarda ti mostro solo alcuni piccoli esempi

Visualizza Account – Amministratore di rete
Permette di visualizzare tutti gli username, con relative informazioni, quali chi è l'utente reale (tramite codice fiscale ), password in chiaro, rete.
Gestisci software – Amministratore di rete
Questa funzionalità ha come compito quello di gestire tutto ciò che concerne un software dell'applicazione.
In una prima area , che non viene approfondita, inquanto adotta gli stessi principi visti nelle funzionalità precedenti, si ha la possibilità di inserire (o creare è lo stesso), modificare, eliminare e visualizzare i software. Le form sono compilabili in modo coerente con la struttura del software. Per ogni software vi è un campo architettura (32 bit , 64 bit ), uno stato (disponibile o non), ed una tipologia di software (sw applicativo o sistema operativo). In una seconda area invece, vi è la funzionalità lista autorizzati\responsabili software di seguito approfondita.

Lista autorizzati\responsabili software – Amministratore di rete
Si divide a sua volta in altre due funzionalità: una relativa alle autorizzazioni per il software ed una relativa ad i responsabili dei software

Autorizzazione software – Amministratore di rete
Non tutti gli utenti sono autorizzati ad utilizzare alcuni software:
Alcuni di essi possiedono privilegi particolari,altri vengono autorizzati temporaneamente. In questa pagina è possibile gestire tale aspetto. Nel caso in cui un software non abbia utenti autorizzati non vuol dire che non può essere utilizzato da nessuno ma semplicemente che non rientra tra quei software sensibili da prevedere un "Autorizzazione" ad hoc per il suo utilizzo. Da questa schermata è possibile effettuare una delle tre operazioni:

Autorizza un utente
Rimuovi l'autorizzazione di un software
Stampa l'elenco di tutti gli autorizzati dei diversi software

Autorizza un utente – Amministratore di rete
In questa sezione vi sono due menu a tendina: uno per selezionare un utente, ed un altro per selezionare un software del db. Validando le scelte si è creata l'autorizzazione ad un utente per un software.

Rimuovi l'autorizzazione di un software – Amministratore di rete
Da apposito menu a tendina si seleziona quale autorizzazione, creata ad hoc ad un utente per utilizzare il un software, deve essere rimossa.

Stampa l'elenco di tutti gli autorizzati dei diversi software – Amministratore di rete
Stampa tutti le autorizzazioni utente-software.

Responsabile software – Amministratore di rete
Un utente responsabile di un software è un utente che possiede il software originale o una copia dello stesso:
Oltre a possedere fisicamente il software,conosce i parametri di configurazione e le corrette istruzioni da eseguire per l'installazione di uno specifico software. Nel caso un software non abbia un responsabile vuol dire semplicemente che non si tratta di un software particolarmente sensibile da prevedere un "Responsabile". Questa funzionalità ha le stesse caratteristiche implementative di Autorizzazione software, con unica differenza concettuale: non si tratta più di autorizzazioni, bensì responsabilità, cioè essere proprietario-titolare del software.

Cambia posizione server – Amministratore di rete
Questa funzionalità permette di modifica la posizione e lo stato di un server. Vi sono tre pulsanti:
posiziona server
sposta server
riconsegna server
Cliccando su uno di questi pulsanti, viene aperto un menu a tendina con alcuni server del bd.
Se si sceglie posiziona, si visualizzano tutti i server ancora “In magazzino” , e si deve decidere il nuovo stato (eccetto “In magazzino”), la nuova posizione ed il nuovo assegnatario.
Se si sceglie sposta, si visualizzano tutti i server che non sono nello stato “In magazzino” , e si deve decidere un nuovo stato (eccetto “In magazzino”), una nuova posizione ed il nuovo assegnatario.
Se si sceglie riconsegna, si visualizzano tutti i server che non sono nello stato “In magazzino” , e lo si porta nello stato “In magazzino”. Nel caso vengano riscontrati errori di inconsistenza opportuni messaggi d'errore verranno visualizzati. Ad esempio se cliccando posiziona server, non si assegna nessuna posizione, lo stato essendo incoerente provocherà un messaggio d'errore.

Configura Server – Amministratore di rete
Dopo aver selezionato uno dei server dal menu a tendina della bd (non vengono visualizzati quelli in magazzino ed inefficienti), si ha la possibilità di configurare il server mediante una semplicissima form: si può modificare l'indirizzo ip, il suo nome macchina, e la rete di lavoro.
 

marino51

Utente Attivo
28 Feb 2013
3.041
192
63
Lombardia
sei nel "volume" riservato all'Information Technology, forse la più facile per te ....
cerca di renderla più leggibile con delle immagini riprese dall'applicativo

ti allego come esempio la documentazione realizzata per un sistema integrato di approvvigionamento e magazzino,
sono schede specifiche rivolte all'operativo, come potrai vedere,

i files nella cartella sono già raccolti ad indice,
le schede riproducono un esempio concreto del lavoro quotidiano dell'operativo
viene coperto l'intero processo

Cattura_1.PNGCattura_2.PNG

ciao
marino
 
Discussioni simili
Autore Titolo Forum Risposte Data
T documentazione javascript Javascript 0
dark ...documentazione sulla privacy Leggi, Normative e Fisco 0
B documentazione transact sql Database 1
B documentazione XML XML 3
K [javascript] Tecnica per rilevare celle contenenti caratteri ricevute in dinamico Javascript 1
B Cerchiamo webmaster per creazione e assistenza tecnica nuovo forum Offerte e Richieste di Lavoro e/o Collaborazione 1
M vs. opinione, tecnica, del mio nuovo sito Presenta il tuo Sito 6
C scelta tecnica importante Database 0
O contabilità tecnica Database 0
O contabilità tecnica in ACCES MS Access 1
felino Applicazione CRUD su hosting condiviso PHP 0
R [c#] Proteggere il codice dell'applicazione C/C++ 0
D [PHP] [RETRIBUITO] cercasi esperto programmatore per realizzare applicazione in html e codice iframe PHP 0
D [RETRIBUITO] cercasi esperto programmatore per realizzare applicazione in html e codice iframe Offerte e Richieste di Lavoro e/o Collaborazione 2
F [PHP] Organizzare le directories sul server per un'applicazione web PHP 9
G [Javascript] Intercettare cambio applicazione Javascript 0
S Come distribuire una applicazione PHP in Cloud Cloud Computing e Cloud Server 0
M [SI CERCA] Grafico per rinnovare applicazione My Shopping List Offerte e Richieste di Lavoro e/o Collaborazione 0
C [RETRIBUITO] Sviluppo applicazione web gestione fantacalcio Offerte e Richieste di Lavoro e/o Collaborazione 0
D Applicazione Database (php,html) PHP 0
A [CERCO] cerco esperto di codici HTML e JavaScript per lavorare ad 1 applicazione Offerte e Richieste di Lavoro e/o Collaborazione 1
A APP per scaricare documento XML e visualizzarlo all'interno dell'applicazione Sviluppo app per Android 1
felino [Windows XP] Errore Icone Programmi e Lancio Applicazione Windows e Software 5
H Selezionare la versione di Access Runtime in base all' applicazione MS Access 0
H Selezionare la versione di Access Runtime in base all' applicazione MS Access 0
voldemort [Java] Connettere MySQL con applicazione j2ee Java 1
G Io ho finito la mia prima applicazione web con MVC ed ho bisogno di metterla in linea ma non so come ASP.NET 2
A Semplice applicazione con le facebook api PHP 1
jacobous Applicazione Sviluppo app per Android 3
A Modulo custom Drupal e applicazione java CMS (Content Management System) 0
I 4 aiuti per un'applicazione intranet PHP 16
E [VB.NET] pagine htm da applicazione .NET Framework 1
A Ricerca interna in una applicazione Sviluppo app per Android 1
L Realizzare applicazione per hotel con camere disponibili PHP 2
onweb Vendo applicazione asp.net - block notes Altri Annunci 0
I Applicazione Offerte e Richieste di Lavoro e/o Collaborazione 1
L [Java] Consigli progettuali per una semplice applicazione Java 6
E Creare DataBase in applicazione Android con Phonegap Database 12
M Problema avvio applicazione PHP PHP 8
E Come creare e inserire un database in un'applicazione in fase di sviluppo Sviluppo app per Android 1
giamma tool o applicazione per html css HTML e CSS 0
M esecuzione comando shell da applicazione php su client PHP 5
C Applicazione per bambini HTML e CSS 0
A Sviluppo applicazione php PHP 0
S Vendo applicazione (sviluppata privatamente) che prende altre pagine di facebook e le rende vostre! Annunci servizi di Social Media Marketing 0
E Richiesta fattibilità sviluppo applicazione ios Sviluppo app per iOS 0
A Primi passi applicazione con Javaswing Java 2
M Come fare il debug di una applicazione web su Internet Explorer 8 jQuery 1
R Cerco programmatore per applicazione Windows Offerte e Richieste di Lavoro e/o Collaborazione 0
M Organizzare applicazione in moduli PHP 1

Discussioni simili