soc-pe-bot
commented
1 year ago Team's Response
It is unclear what the tester means by fields, documentation sense or implementation sense.
If the tester is referring to flags as fields, it had already been mentioned under the Parameters section that flags can be provided in any order. We do not believe that it is necessary to repeat this in every section of the UG.
Items for the Tester to Verify
:question: Issue response
Team chose [response.IssueUnclear]
- [x] I disagree
Reason for disagreement: Developers have understood the problem raised.
While the developers do not believe that it is necessary to repeat the instruction in every section of the UG, given the condition of their UG (which is lengthy, messy and convoluted in the case of this team's UG), it is much suggested that the developers might as well include crucial parts of the input in every section. Lest users will get lost in that long and messy chunk of a word that has minimal padding to separate the portions and miss out on the crucial instructions.
Expecting users to remember one sentence from a messy chunk would be too high and brazen of an expectation. Either make the UG concise or repeat important sentences
It will be good to mention in the user guide that fields do not have to be in sequence. Mentioned previously but speaking in terms of documentation sense, where previously was about implementation sense