Estoy tratando de documentar una pieza de software que escribí en detalle. Un SAS tiene un nivel demasiado alto y no cubre la API. Encontré varios ejemplos de una SDS en línea, pero no veo una tendencia en su formato.
Me pregunto si hay algunas pautas generales para escribir una especificación de diseño de software o cuál es el mejor enfoque.
documentation
api
uml
design
sj755
fuente
fuente
Respuestas:
Podría hacer mucho peor que comenzar con la Descripción del elemento de datos del documento de diseño de software DOD-STD-2167A .
El Departamento de Defensa de los Estados Unidos tiene mucha experiencia en el desarrollo de software, mucho más que cualquier otra compañía. También tienen un interés personal en conseguir software que hiciera el trabajo y que pudiera mantenerse en el futuro. Se tomaron muchas molestias para averiguar qué información necesitaba estar en los diversos documentos que respaldan un proyecto de software, utilizando la experiencia de una gran cantidad de proyectos y más de unas pocas fallas muy costosas.
El DID del plan de desarrollo de software (disponible aquí ) incluye una serie de elementos que deben abordarse. Si observa detenidamente, notará que esas secciones están escritas en la sangre de los administradores de programas que no abordaron esos elementos.
fuente