Software Engineering Documentation

To create Software Design Documentation for your project using LibreOffice software which is a part of our Linux installation in the Prism lab, follow these steps:

• Login to a Linux Prism machine. Open home/<your_name>/.config/libreoffice/4/user/gallery directory (Note: if this directory does not exist, run a LibreOffice Draw program once, and it will get created authomatically)
• Download the attached zip file
• Unzip it to the above-mentioned location
• You will see 3 files (bon.sdg, bon.sdv and bon.thm). (Important: right-click the files, chose Properties and make sure their Permissions are set to “Read only”)
• Run your LibreOffice Draw program. When it opens, click the “Gallery” button (1), then open the “BON” theme (2). You will see elements conveniently prepared for you in the gallery (3)

(Scroll to the bottom of the page to see some details/conventions)

You can drag and drop elements from the BON gallery to the working area to use them as templates for your Design Document diagrams. Once you are satisfied with your diagram, open the “Format” menu, select “Page” and adjust the page height value so that the page gets cut to only include your diagram.

Your diagram should fit the page snugly

• Now you can save your drawing.
• Open the attached template (TO DO) with LibreOffice Writer to create your Design Document.
• To add the diagram that you have created to the Design Document, select Insert → Object → OLE object and click the “Create from file” button. Then browse to the selected drawing and click OK.

The incorporated diagram is still editable.

You can always double-click a diagram to edit it in place.

Here are some details/conventions for the BON elements we use:

• We use the following connectors to distinguish between the 3 types of class relationships (here is some useful reading on the standard BON conventions)

• To “wrap” a few classes into a cluster, position the cluster container element above the selected classes and resize it so it covers them completely. Then, while the cluster container is still selected, click Modify → Arrange → Send to Back to position it behind the selected classes.

• We have compiled a list of useful math/logic symbols to use in your diagram. Look for the “math symbols” list in the BON gallery