Qual è la differenza tra specifiche tecniche e documenti di progettazione?

Un documento di progettazione software può essere al livello di un sistema o componente e generalmente include:

• obiettivi o requisiti rilevanti (funzionali e non funzionali);
• struttura statica (ad es. componenti, interfacce, dipendenze);
• comportamento dinamico (come interagiscono i componenti);
• modelli di dati o interfacce esterne (esterne al sistema / componente descritto nel documento); e
• considerazioni sulla distribuzione (ad es. requisiti di runtime, componenti di terze parti).

Si noti che tutte queste descrizioni sono a un livello astratto. Lo scopo è di dare al lettore un'ampia comprensione generale del sistema o componente. Potrebbero esserci molti livelli di documenti di progettazione (ad esempio, a livello di sistema o di componente).

Una specifica tecnica descrive i minimi dettagli di tutte le parti o di parti specifiche di un progetto, come ad esempio:

• la firma di un'interfaccia, compresi tutti i tipi / strutture di dati richiesti (tipi di dati di input, tipi di dati di output, eccezioni);
• modelli di classi dettagliati inclusi tutti i metodi, attributi, dipendenze e associazioni;
• gli algoritmi specifici utilizzati da un componente e il modo in cui funzionano; e
• modelli di dati fisici inclusi attributi e tipi di ogni entità / tipo di dati.

Le specifiche tecniche, almeno sotto forma di un disegno tecnico, sono parte dei documenti di progettazione, insieme ad esempio a liste di requisiti, disegni funzionali, storie utente, prototipi di grafica, usabilità studi, diagrammi UML, diagrammi di processi aziendali, specifiche del modello di dati, ecc.

Le specifiche tecniche del tipo che scrivi dopo il fatto, per documentare il prodotto finito, sono non generalmente parte dei documenti di progettazione, ma possono essere inclusi nel set di documenti di progetto di un versione successiva (per riferimento) o un altro prodotto che si basa su di essi.