Qual é o formato geral de uma especificação de design de software?

Estou tentando documentar um software que escrevi em detalhes. Um SAS é muito alto e não cobre a API. Encontrei vários exemplos de um SDS online, mas não vejo uma tendência em seu formato.

Gostaria de saber se existem algumas diretrizes gerais para escrever uma especificação de design de software ou qual é a melhor abordagem?

— sj755
fonte

bradapp.com/docs/sdd.html

— Robert Harvey

rivier.edu/faculty/vriabov/… ... e vários outros que podem ser obtidos no Googling 'Software Design Specification'. Todos eles assumem mais ou menos a mesma forma, descrevendo essencialmente o software a ser escrito em termos das classes, módulos e métodos necessários, além de quaisquer restrições e condições de design aplicáveis.

— 21413 Robert Harvey

relacionado: programmers.stackexchange.com/questions/80974/…

— Doc Brown

Você poderia fazer muito pior do que começar com a Descrição do Item de Dados do Documento de Design de Software DOD-STD-2167A .

O Departamento de Defesa dos EUA tem muita experiência em desenvolvimento de software, muito mais do que qualquer empresa. Eles também têm um grande interesse em obter software que fizesse o trabalho e que pudesse ser mantido no caminho. Eles se deram ao trabalho de descobrir quais informações precisavam estar nos vários documentos que suportam um projeto de software, usando a experiência de um grande número de projetos e mais do que algumas falhas muito caras.

O DID do Plano de Desenvolvimento de Software (disponível aqui ) inclui vários itens que devem ser abordados. Se você olhar atentamente, perceberá que essas seções estão escritas no sangue de gerentes de programas que falharam em abordar esses itens.

— John R. Strohm
fonte