Quali sono gli elementi chiave da includere nella documentazione di supporto? [chiuso]

Question

Ho creato un'applicazione che necessita di 'consegna' al gruppo di supporto nel mese successivo.

L'applicazione è abbastanza piccola (sviluppo di 2 mesi), ed è composta da due applicazioni lato client e un database, è scritta in c # per la piattaforma Windows.

Ho un'idea generale di cosa includere in un documento di supporto, ma finora non ho avuto bisogno di fare molti documenti di supporto nella mia carriera e voglio un solido elenco di elementi da includere.

Suppongo che il mio obiettivo sia rendere le vite di tutti nel gruppo di supporto più facili e il più stressanti possibile.

Quindi suppongo che le mie domande siano:

1. Cosa dovrebbe assolutamente contenere un documento di supporto

2. Quali elementi aggiuntivi hai inserito nei documenti di supporto per renderli ancora più utili.

3. Quali altre attività possono essere svolte prima della consegna per rendere più semplice tutta la nostra vita?

Answer 1

Essendo stato professionale da entrambe le parti, posso dire che quanto segue dovrebbe essere mandatorio :

• la documentazione del codice (javadoc, doxygen, ecc.)
• dettagli sul processo di compilazione
  • dove ottenere la fonte corrente
  • come archiviare i bug (accadranno)
  • percorso per fornire patch alla fonte o ai clienti
• come funziona (semplice, ma spesso trascurato)
• porzioni personalizzabili dall'utente (ad esempio c'è un componente di scripting)
• contatti primari per ciascun componente, noto anche come percorso di escalation
• incoraggiamento per feedback da parte del Supporto su cos'altro vogliono vedere

Sono sicuro che molte altre cose possono essere aggiunte, ma queste sono le massime priorità nella mia mente.

Answer 2

1. Specifiche funzionali (se ne hai uno)
2. Manuale dell'utente. Creane uno se non lo hai
3. Manuale tecnico, contenente
   • Diagramma di distribuzione
   • Software utilizzati
   • Dettagli di configurazione e build
   • Deatils delle password del server ip e admin / oracle / websphere
4. Documento di prova
5. Visualizzazione del documento in vista
   • Dove sono conservati tutti i documenti
   • Repository di controllo versione e relativi dettagli utente / progetto
   • Nome utente / password dell'applicazione
6. Qualsiasi supporto SQL / strumenti ecc. creato dal team di sviluppo, per analisi, caricamento di dati ecc.

Answer 3

1. Includi schermate delle operazioni e dell'output.
2. Preferisci " online facilmente aggiornabile " doc (simile a wiki) invece di carta o pdf.
3. Se online, rendilo ricercabile e reticolato.

Answer 4

• Un manuale è una cosa ordinata (immagini, descrizioni, ecc.)
• Una carrellata delle diverse funzionalità all'interno dell'applicazione

Questo è quello che sto pensando in cima alla mia testa se questo è "solo" per il personale di supporto e non ulteriore sviluppo.