[TESTING] [200000XX] Functional Specs - Pre-Publication Check 1

[mathiskakal]

LABELS

Text Format

Bold: replaced word in original text Normal: Citation from original text Italic: Comment

Suggestions

IMPROVEMENT: something to add, to be defined by document owner TYPO: a suggestion for correcting a found typo

What has been quality checked?

Compliance with Use cases/Business Requirements

• [x] Make sure it follows the client's requests.
• [x] Make sure In Scope and Out of Scope is well set
• [x] Make sure it is in line with the rest of the Documents

Readability

• [x] Make sure paragraphs are mostly never over 3-4 lines long.
• [x] Make sure the document features at least 1/10th visuals.
• [x] Make sure the document features some admonition for information hierarchy.
• [x] Ensure accessibility by checking Links, Image alt attributes, and presence of Table of content
• [x] Make sure the heading logic is clear (no H2 in an h3 for instance)

Coherence

• [x] Make sure the document doesn't contradict itself and with the rest of the documents.

Spell Check

• [x] Make sure the document is written in a professional, idiomatic American English

Global Suggestions

• [x] IMPROVEMENT: The team Members: Wouldn't it be nice to have a description of the roles?
• [x] IMPROVEMENT: Add "The Client" to the glossary for all further references
• [x] IMPROVEMENT: Add "The Device" to the glossary for all further references
• [x] IMPROVEMENT: Somewhere in the document, make a recap of the client's requests, as formulated in the slides?
• [x] IMPROVEMENT: Add "The solution" to the gloassary for all further references

Detailed Suggestions

1.1 Overview

• [x] IMPROVEMENT: Can be controlled primarly using a mobile application (wouldn't there be other ways in the future?)
• [x] IMPROVEMENT: Wouldn't it be nice to have a simple schema of the important aspects of the project, or a 3D model of it for the external reviewers to better understand what we are talking about?

1.2 Purpose

• [x] IMPROVEMENT: Maybe mention that the client explicitly requested that we tackle the battery issues first, but recognize that there or other aspects to this project?

1.3 Personas

• [x] TYPO: The ski equipment rental is another(...).
• [x] TYPO: The rental company would like to be (...)
• [x] TYPO: They would like to be notified if the device (...)

1.4 Use cases

• [x] TYPO: They lock their skis with SportShield (...)
• [x] TYPO: After their meal, the user unlocks the skis (...)
• [x] TYPO: A user have lost their skis.
• [x] TYPO: They use the mobile app to locate (...)
• [x] TYPO: and can retrieve their skis.

2 How SportShield works

• [x] IMPROVEMENT: Create a glossary entry for buzzer
• [x] TYPO: an electromagnet and a GSM module.
• [x] IMPROVEMENT: The lock consists of a Kevlar security cable that can be wrapped around the (...)
• [x] IMPROVEMENT: This is the perfect place to add schematics here, to explain what this cable is etc, and how the locking mechanism works.
• [x] IMPROVEMENT: As provided by the Client the device has two modes of operation:
• [x] TYPO: The device detects two types of motion: normal and strong shock.
• [x] IMPROVEMENT: The device sends a notification to the mobile app through the cellular network (GSM) only if a strong (...)
• [x] IMPROVEMENT: Which sends the unlocking signal to the device via Bluetooth

3.1 Battery Management

• [x] IMPROVEMENT: at a rate of 6 hours per day of normal operation, meaning that the user locks it and unlocks it twice during that time span.
• [x] TYPO: receives one of these notifications, they would have to unlock (...)
• [x] IMPROVEMENT: To ensure that the battery can last long enough (...) What IS long enough? 3 years of exaggerated operation while retaining 80% of original capacity, or 5 years of normal operation while retaining 80% of original capacity, 7 years etc...

3.2 Motion Detection

• [x] IMPROVEMENT: rotations around three axes. Mention the 6 degrees of Freedom that should be used
• [x] IMPROVEMENT: Describe an example (use case) that would define a shock and a strong shock
• [x] TYPO: produces a sound that would deter a potential thief from (...)
• [x] TYPO: alert them of the situation

3.3 Unlock

• [x] IMPROVEMENT: Mention that the electromagnet is out of scope given that we do not have the hardware to make it function, nor test it.
• [x] IMPROVEMENT: pull the cable out while also saving battery.

3.4 Alarm

• [x] IMPROVEMENT: ensure that the alarm can be heard: at which distance, by whom, and in which conditions? I suppose during a stormy weather, it would be less audible

3.5 Notifications

• [x] IMPROVEMENT: mention two types of notifications: the ones sent thanks to Bluetooth messages and the ones sent thanks to the GSM

3.6 GPS Positioning

• [x] TYPO: so the GSM implementation is only temporary.
• [x] IMPROVEMENT: add that the following code this is in JSON Format

3.7 NFC

• [x] IMPROVEMENT: The client mentioned that NFC redundancy would be nice, not that the solution has to feature it, therefore the user would only have to tap the device with the (...)

4. Risks and assumptions

• [x] IMPROVEMENT: Privacy => did you mean Security instead?

4.3 Out of scope

• [x] IMPROVEMENT: Physical Hardware security and integrity is mostly out of scope, due to time constraints and client requirements.