Take the 2-minute tour ×
Programmers Stack Exchange is a question and answer site for professional programmers interested in conceptual questions about software development. It's 100% free, no registration required.

This question is purely from academic point of view. As part of the software engineering lab, a design document is to be created after generating the SRS. Is there any standard for creating the design document. Since we followed IEEE standard for creating the SRS.

What all things can be included in the design document from the academic point of view? I am thinking of including different UML diagrams.

share|improve this question

closed as off-topic by gnat, GlenH7, MichaelT, Ozz, Michael Kohne Oct 3 '13 at 20:03

This question appears to be off-topic. The users who voted to close gave this specific reason:

  • "Questions asking us to recommend a tool, library or favorite off-site resource are off-topic for Programmers as they tend to attract opinionated answers and spam. Instead, describe the problem and what has been done so far to solve it." – gnat, GlenH7, MichaelT, Ozz, Michael Kohne
If this question can be reworded to fit the rules in the help center, please edit the question.

add comment

1 Answer 1

An overview of the standards can be found here. IEEE-Standard from 2009 can be found here.

What I teach is:

  • Consider who's the target audience, depending on who's going do use the document the contents will most likely need adaption. In any case the required level of details changes.
  • Apart from describing the current design, the DD should include decisions (i.e., arguments!) that led you there. Decisions should usually derive from requirements.
  • What should be included is:
    • A high-level architecture overview
    • A description of the components shown in the overview, including dependencies, input/output/processing behavior, and how this is reflected in the implementation (e.g., how structure is mapped to packages)
    • A description of the data model and the formats used
    • Information about how to build the product may be of interest to some stakeholders
  • Whether or not to include UML diagrams depends on what kinds of diagrams and for what purpose. Including UML class diagrams for everything is rarely useful. Providing sequence diagrams to show component interaction can help.
share|improve this answer
add comment

Not the answer you're looking for? Browse other questions tagged or ask your own question.