Open JumpyJay opened 4 days ago
[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]
We respectfully classify this issue as severity.VeryLow
, as it is A flaw that is purely cosmetic and does not affect usage
.
We also think that the screenshot for listTxn
does not add value to the UG and we do not intend to add such screenshots even in future iterations of the app, therefore, we respectfully classify it as response.Rejected
.
*Why we think that adding a screenshot for listTxn
provides such insignificant value that we do not intend to add it even in future iterations of the app:
The listTxn command is designed to provide a straightforward output: a list of all transactions in the transaction book. This format is already text-based and intuitive, with no additional visual elements (e.g., graphs, etc) that might require clarification. A screenshot would simply replicate the text output and provide no new information.
SpleetWaise's main focus is functionality and not necessarily on visual appeal. For users interacting with such a CLI-first application, adding a screenshot would not enhance their understanding or experience, as the displayed data is purely textual.
Screenshots require updates whenever the UI or command output changes. Maintaining textual documentation is significantly easier and more efficient than updating images, reducing the risk of outdated or inconsistent documentation.
The purpose of the User Guide is to explain commands and their expected outputs. For listTxn
, the current textual description already fulfils this purpose effectively. A screenshot would be redundant, adding little to no additional clarity.
Team chose [response.Rejected
]
Reason for disagreement: [replace this with your reason]
As listTxn is one of the main features of the app, showing all transactions in a dedicated tab, a screenshot showing how the tab looks like and how the list of transactions is displayed could improve the user experience and give them a better idea of the feature