Contradictory Instructions in UG

[nus-se-script]

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

---

Overview One instance in the UG states users are allowed to change the contents of the JSON file. Another instances says users should not do so. Clear contradiction. This is quite serious as it can severely confuse the user.

Steps to reproduce

• View "Context on Tether" section
• View "The structure of Tether" section

Expected behaviour

• Clear instructions

Actual behaviour

• Contradictory instructions

Potential solution

• Give uniform instructions

Screenshots

Instruction 1:

Instruction 2:

---

_{[original: nus-cs2103-AY2324S2/pe-interim#2601] [original labels: severity.Medium type.DocumentationBug]}

[yashpola]

Team's Response

Indeed, the phrasing is not the clearest and we recognise the ambiguity caused by the 2 sentences. However, by "You may even directly edit your data..." we were referring to editing the data in the file such as editing names or emails, whereas by "do not touch the data folder..." we meant do not move the file or folder itself to any other location. We made an assumption that the surrounding context of the sentences was enough to clarify their meaning, but we should've been more explicit. Since it is just a matter of ambiguous phrasing and not contradictory functions of the app, we do not feel this warrants medium severity.

Duplicate status (if any):

--