Struttura della documentazione tecnica del software

Naviga le tue risposte
3

Dire che ho un progetto software per il quale la documentazione tecnica dovrebbe includere

  • Un documento di licenza
  • Un elenco di terminologia utilizzata
  • Un'introduzione su ciò che il software fa
  • Una breve guida rapida
  • Documentazione completa degli strumenti coperti dal progetto
  • Documentazione di formati e protocolli di file
  • Un riferimento API
  • Un elenco di bug noti
  • Una lista di cose da fare
  • Una serie di esempi

Che cos'è un buon ordine di questi punti?

In che modo questi punti possono essere organizzati in capitoli, sezioni, sottosezioni e sottosezioni?

Uno degli strumenti ha una struttura di configurazione gerarchica. Dovrebbe essere rappresentata questa struttura nel profilo della documentazione (questo risulterà in un contorno molto profondo) o dovrebbe essere in qualche modo appiattito?

    
posta user877329 09.02.2014 - 19:55
fonte

1 risposta

1

Per questo tipo di progetti, in cui i prodotti software richiedono una grande documentazione, è meglio non includere tutte le informazioni in un singolo documento.

Un buon approccio a questo per avere una cartella di lavoro per gli sviluppatori che è un insieme di diversi documenti direttamente correlati al prodotto software.

Puoi strutturare la tua cartella di lavoro in modo che includa

  1. Un documento di licenza
  2. Un'introduzione su cosa fa il software, una breve guida rapida, completa documentazione degli strumenti coperti dal progetto, documentazione di formati e protocolli di file, un riferimento API , in un documento separato
  3. Gli elenchi di bug noti e la lista di cose da fare in un altro documento
  4. Un set di esempio

Quindi avrai 4 documenti diversi nella tua cartella di lavoro. Dovrai nominarli in modo che gli sviluppatori possano capire facilmente il contenuto del documento.

Spero che questo aiuti

    
risposta data 19.02.2014 - 09:18
fonte

Leggi altre domande sui tag

I membri accessibili di una classe interna dovrebbero essere anch'essi interni? Cos'è un modo uniforme per esprimere Paese, Città, Stato? (Norma ISO, ecc.)