J'essaie de documenter un logiciel que j'ai écrit en détail. An SAS est trop élevé et ne couvre pas l'API. J'ai trouvé plusieurs exemples d'un SDS en ligne, mais je ne vois pas une tendance dans leur format.
Je me demande s'il existe des directives générales pour écrire une spécification de conception de logiciels ou quelle est la meilleure approche?
Vous pourriez faire beaucoup plus pire que de commencer par Données de données de conception logicielle DOD-STD-2167A .
Le département de la défense des États-Unis a beaucoup d'expérience avec le développement de logiciels, beaucoup plus qu'une entreprise. Ils ont également un intérêt direct pour obtenir des logiciels qui ont fait le travail, et cela pourrait être maintenu sur la route. Ils sont allés avoir beaucoup de mal à comprendre quelles informations devaient être dans les différents documents prenant en charge un projet de logiciel, en utilisant l'expérience d'un grand nombre de projets, et plus de quelques échecs très coûteux.
Le plan de développement logiciel DID (disponible ici ) comprend un certain nombre d'éléments à traiter. Si vous regardez de près, vous remarquerez que ces sections sont écrites dans le sang des gestionnaires de programme qui n'ont pas répondu à ces éléments.