parth-io / pe

0 stars 0 forks source link

The section on "Implementation" in the DG is confusing #15

Open parth-io opened 1 year ago

parth-io commented 1 year ago

"Implementation
This section describes some noteworthy details on how certain features are implemented.
UI Design
Proposed Implementation"

The above is taken from the DG. But this is confusing, as the "UI Design" talks about three things: desired endstate of the UI, proposed alternatives, and the current choice.

Instead of mentioning all 3 under "Proposed Implementation", a separate subsection called "Current Implementation" should be created to talk about the current choice. Then another subsection called "Alternatives considered" can talk about the other alternatives considered. Then "Proposed Implementation" should only talk about the desired endstate - the use of Material Design.

This will help reduce confusion on what is implemented, what are the alternatives possible, and what is the ideal implementation.

nus-se-bot commented 1 year ago

Team's Response

Material Design as "Proposed Implementation" is reasonable as we are unable to adhere to all the aspects of Material Design due to limitations of JavaFx.

For the rest of the issue, we are not too sure about what you mean.

Items for the Tester to Verify

:question: Issue response

Team chose [response.IssueUnclear]

Reason for disagreement: [replace this with your explanation]