12 messaggi dal 11 aprile 2002
Salve a tutti,
vorrei fare la documentazione di un sito asp senza usare programmi a pagamento del tipo "ASP Documentation Tool".

Vorrei sapere dagli utenti del forum, se c'è sulla rete, un prototipo di documento Standard per i programmatori asp. Inoltre se qualcuno di voi ha già esperienze in merito, sarebbe molto utile avere un esempio di documentazione.

Vi ringrazio,
Marco.
Te intendi documentazione di carattere tecnico per i programmatori, o documentazione di carattere pratico per gli utilizzatori?

Io ti rispondo come procedo io a livello personale:

1) Scrivere codice utilizzando nomenclatura in inglese
2) Commentare il codice, e spiegare già nel codice le procedure funzioni complesse, risulta già essere una buona documentazione preliminare.

3) Scegliere una metodologia di sviluppo software adeguata

4) Nella relazione cartacea devono essere presenti fondamentalmente i seguenti punti:

- Specifica e analisi dei requisiti
- Requisiti hw e sw richiesti per l'installazzione
- Manuale d'uso utente
- Struttura della base di dati con illustrare le tabelle e relazioni con esse
- Schema logico del software e diagrammi UML
- Descrizione delle funzioni principali e cruciali

5) Tutto quello che può essere utile ai programmatori che dovranno metterci mano è buona norma seguirlo.

Qui puoi trovare qualche documentazione che ho redatto assieme a colleghi nello svolgimento di progetti sperimentali per l'università:
http://www.futuresoftware.it/innovazione.asp

Ciao Marco

Corso SEO DeepSEO
Libro SEO, SEM e Web Marketing
Siti Web Parma
12 messaggi dal 11 aprile 2002
Grazie per la risposta.
La documentazione che intendo è quella di carattere tecnico per i programmatori quindi oltre al punto 1 e 2 che sottoscrivo in pieno, mi piacerebbe fare una documentazione "cartacea" di ogni pagina del sito web.

E' difficile spiegare ciò che voglio ed è per questo che chiedevo se esiste uno standard per documentazione cartacea di siti web (asp nel mio caso ma credo che possa essere universale).
Ad esempio vorrei scrivere nel documento nel dettaglio "il senso" di una pagina se è di lettura o scrittura, le funzioni jscript o vbscript utilizzate, le store procedure chiamate, il tipo di connesione e tutto quello che possa servire ad un programmatore. Tutti quei parametri che compongono la pagina.

Esisterà una struttura standard per fare una bozza di documento?

Ciao
Modificato da carlo78 il 10 settembre 2008 15.07 -
Da quanto ne so io per asp classico non ne esistono non a pagamento (ripeto per quel che ne so io),
c'è questo tool che potrebbe fare al caso tuo http://vbdox.sourceforge.net/
o

http://blogs.ugidotnet.org/rnocera/archive/2007/11/09/microsoft-crm-documentation-generator.aspx

Invece se utilizzi vs 2005 o vs 2008 puoi generare un doc (per intenderci tipo quello che puoi generare per java o jsp con gli ambienti di sviluppo NetBeans o Eclipse) usa http://blogs.devleap.com/rob/archive/2006/08/12/13206.aspx
oppure http://ndoc.sourceforge.net/

Altri non ne conosco.
SPero di esserti stato utile.
MArco

Corso SEO DeepSEO
Libro SEO, SEM e Web Marketing
Siti Web Parma
47 messaggi dal 09 settembre 2008
Per quanto riguarda la parte lato Web non ho mai avuto modo di applicare
una documentazione tecnica, per la parte di windows application esiste
il linguaggio UML (Unified Model Language) che permette di definire
alcuni diagrammi d'uso, tra cui:
- Use case Diagram
- Interaction Diagram
- State Diagram
- Collaboration Diagram
- Class Diagram

Nel tuo caso, esiste l'UWL (UML-based Web Engineering) e trova il suo
sviluppo con il software ArgoUWE.
Qui puoi scaricare il programma :
http://www.p2pforum.it/forum/archive/index.php/t-226935.html


Ti rilascio al sito di Wikipedia per cercare maggiori informazioni sull'UML,
altrimenti a questo link
http://www2.mokabyte.it/cms/article.run?articleId=UEN-ES4-JNX-72L_7f000001_7470813_5fabe8a8

Spero di aver centrato le tue richieste...
Ciao

Torna al forum | Feed RSS

ASPItalia.com non è responsabile per il contenuto dei messaggi presenti su questo servizio, non avendo nessun controllo sui messaggi postati nei propri forum, che rappresentano l'espressione del pensiero degli autori.