[TESTING] [201000XX] Technical Specs - Pre-Publication Check 1

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 Functional Specifications

[x] Make sure it is in line with the Functional Specifications
[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: italic suggestion
[x] TYPO: Make sure you check capitalization of words, since it is seemingly random
[x] TYPO: Use Grammarly before pushing documentation.
[x] TYPO: Add full stops

Detailed Suggestions

Definition of Technical Specification

[x] TYPO: Definition of a Technical Specification
[x] IMPROVEMENT: The goal is to [...] translate the Functional Requirements. translate the requirements into what? missing context

Project Overview

[x] TYPO: The Project has for purpose of creating a security
[x] IMPROVEMENT: sports equipment such as snowboards and surfboards using an alarm system. the Skis are not mentioned?
[x] TYPO: alarm system similar to a car anti-theft protection

Functional Specifications

[x] TYPO: Functional Specifications
[x] IMPROVEMENT: This document is a more detailed version of the functional specification. Is "more detailed" sufficient to explain the purpose of the document? Suggestion: a Technical Specs doc contains more actionable/low level data than the Functional Specifications.

Glossary

[x] TYPO: Add full stops at the end of sentences.

Objectives

[x] TYPO: objective of our participation.

Out of Scope

[x] IMPROVEMENT: Make a list the out of scope items to improve readability
[x] IMPROVEMENT: Make a list of in scope items as well

Work Environment

[x] TYPO: Work Environment
[x] IMPROVEMENT: We are using imposed libraries for C++. Which libraries? Did you mean for the device rather than for C++?
[x] IMPROVEMENT: Would it make sense to have a link to associated documentation for each component
[x] IMPROVEMENT: A GPS module to locate ~~where~~ the device is .
[x] TYPO: Allows internet connection of the device to 2G cellular networks .
[x] IMPROVEMENT: Electromagnet is more accurately: Mini 2728 Small Solenoid Lock
[x] TYPO: A soft metal core...
[x] IMPROVEMENT: The description of the magnet doesn't explain that this serves as the locking mechanism
[x] TYPO: Energy storage for the system to work.
[x] TYPO: NFC antenna. The image you are showing is the 2G Antenna, not the NFC Antenna!
[x] IMPROVEMENT: Add the actual NFC Antenna entry
[x] TYPO: here a component
[x] TYPO: An antenna that sends
[x] TYPO: electronic device that can produce a 120db sound.

Naming Convention

[x] TYPO: To better organise our project we decided to adhere to ~~some~~ naming conventions.
[x] IMPROVEMENT: Add examples of each case, because kebab case isn't clear if you have never seen it...
[x] TYPO: function and variable names

File List

[x] IMPROVEMENT: this doesn't seem up to date with the latest info

File Sorting

[x] IMPROVEMENT: this doesn't seem up to date with the latest info
[x] TYPO: technicalSpecifications is incorrectly nested inside technical specifications

Communication Risks

[x] TYPO: no communication issues between our team and [...]

Potential Risks

[x] IMPROVEMENT: List the risks, their impacts and their possible mitigations will show that you have clearly identified potential risks

Dealing with risks

[x] IMPROVEMENT: State that we have contacted the client to find a solution for the hardware problems.
[x] IMPROVEMENT: You said "troubleshoot before we had to firefight" but this doesn't make sense, you should rather say: "we identified risks and planned action in the event of failure" or something similar

Upgrading Battery

[x] TYPO: We will find [...].

Bluetooth Communication

NFC Communication

[x] TYPO: We will allow [...].
[x] TYPO: can activate the anti-theft system.

Sensor

[x] TYPO: For that , we placed [...]

Electromagnet

[x] TYPO: We will initialize the magnet [...].

Test Plan

[x] TYPO: We prepared a test[...].
[x] IMPROVEMENT: For this, we laid out a plan that you can access [...]

algosup / 2023-2024-project-4-sportshield-team-7

[TESTING] [201000XX] Technical Specs - Pre-Publication Check 1 #22