Skip to content

Software Design Specification

fmudole edited this page Jul 18, 2019 · 10 revisions

Introduction and Document Goals

Software Design Specification is vital for the entirety of a software development life-cycle. Mentioned by accredited source, "The requirements depicts how the business stakeholder visualises the system, its behaviour, its interaction with users, and the system's environment based on which the entire business operation runs"

Software requirements documentation process suffices the need of many stakeholders varying in the areas of expertise. Hence a well-documented requirement document proves to be very essential.

The documentation will provide an in-depth view on the following:

  • frontend system structure: This will contain the User Interface Design for the full application, showcasing the design of entirety of the apps frontend framework.
  • backend system structure: This will contain the supposed data structure storage, security and business logic modal that was implemented (was planned to be implemented).
  • 'overall system structure and backend to frontend integration': This part will contain the logic, software and implementation that were used to connect, the backend to frontend and visa. Showcasing data manipulation with user interaction.
  • online to offline (O2O) business modal integration: This part will provide an O2O business modal integration, with the system.

The above points will be covered in the following section; UML Modelling, Deployment Diagram, Class/Site Diagram, Behaviours: Sequence Diagrams, Persistence, None-functional requirements and wireframes.

UML Modelling

Behavioural UML diagrams is a static structure diagram. A composite diagram in the Unified Modeling Language (UML). It shows the internal structure of a class and the collaborations that this structure makes possible.

Database Modelling in UML contains the following; model classes, identify persistent objects. Assume each persistent class maps to one relational table. Select an inheritance strategy or each class add a unique object identifier. Map attributes to columns. Map associations to foreign keys. Map Aggregation and Composition. Define relationship roles.

this is a draft:UML, not a complete one.

Deployment Diagram

A deployment diagram is a diagram that shows the configuration of run-time processing nodes and the components (hardware, software & middleware on hardware) that live on them that is used to model the static deployment view of a system (topology of the hardware).

In this section, the deployment diagram will be constructed for the overall system. Providing a systematic diagram of the overall system.

Class/Site Diagram

Behaviours: Sequence Diagram

Persistence

None-Functional Requirements

Wireframes

Clone this wiki locally