Sto provando a documentare un pezzo di software che ho scritto in dettaglio. Un SAS è di livello troppo alto e non copre l'API. Ho trovato diversi esempi di SDS online, ma non vedo una tendenza nel loro formato.
Mi chiedo se ci sono alcune linee guida generali per scrivere una specifica di progettazione software o quale sia l'approccio migliore?
Potresti fare molto di peggio che iniziare con il DOD-STD-2167A Software Design Document Data Item Description .
Il Dipartimento della Difesa degli Stati Uniti ha molta esperienza nello sviluppo di software, molto più di qualsiasi altra azienda. Hanno anche un interesse acquisito a ottenere software che ha fatto il lavoro, e che potrebbe essere mantenuto lungo la strada. Hanno fatto un sacco di problemi per capire quali informazioni dovevano essere nei vari documenti che supportano un progetto software, usando l'esperienza di un gran numero di progetti e più di alcuni fallimenti molto costosi.
Il Piano di sviluppo software DID (disponibile qui ) include un numero di elementi che devono essere indirizzati. Se guardi da vicino, noterai che quelle sezioni sono scritte nel sangue dei responsabili del programma che non hanno risposto a quegli articoli.
Leggi altre domande sui tag design api documentation uml