User Tools
eiffel:sdd:start
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
eiffel:sdd:start [2016/07/25 15:19] marina |
eiffel:sdd:start [2018/01/28 22:40] (current) jonathan |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| =====Software Design Document (SDD)===== | =====Software Design Document (SDD)===== | ||
| + | |||
| + | * [[https://www.eiffel.org/doc/eiffelstudio/Producing%20and%20Exporting%20Documentation|Using EiffelStudio IDE for producing documentation]], e.g. in html or RTF form. For an example of //chart view//, //contract view// and //text view// in an RTF format, see {{ :sdd:rtf-views.pdf |here}}. RTF format is useful in documentation of software using Word. | ||
| + | * [[http://seldoc.eecs.yorku.ca/doku.php/eiffel/bon/start| BON or UML class diagrams]]. | ||
| + | * [[https://www.eiffel.org/doc/eiffelstudio/Diagram%20tool|Using EiffelStudio IDE]] to produce BON class diagrams from the program text (automatically) | ||
| + | * [[http://seldoc.eecs.yorku.ca/doku.php/eiffel/faq/bon|BON template]]. A template for producing high quality BON class diagrams (in detail with contracts) for import into Word. | ||
| + | * A Word template for documenting the design of your software is provided at the bottom of this page. The above facilities are useful for producing professional high quality documentation with clear images and accurate representations of the program text in differing views. | ||
| Software design is a process by which the software requirements are translated into a representation of software components, interfaces, and data necessary for the implementation phase. The SDD describes how the software system will be structured to satisfy the requirements. | Software design is a process by which the software requirements are translated into a representation of software components, interfaces, and data necessary for the implementation phase. The SDD describes how the software system will be structured to satisfy the requirements. | ||
| Line 54: | Line 60: | ||
| The IEEE also has a template for a Software Design Document (SDD). It is provided [[https://wiki.eecs.yorku.ca/project/sel-students/p:tutorials:sdd:start|here]] for your information, and is based on IEEE 1016-1998. However, you are encouraged to use the template above for 3311 Design Documentation. | The IEEE also has a template for a Software Design Document (SDD). It is provided [[https://wiki.eecs.yorku.ca/project/sel-students/p:tutorials:sdd:start|here]] for your information, and is based on IEEE 1016-1998. However, you are encouraged to use the template above for 3311 Design Documentation. | ||
| - | |||
eiffel/sdd/start.1469459957.txt.gz · Last modified: 2016/07/25 15:19 by marina
Page Tools
